Chilkat Online Tools

Ruby / Datadog API Collection / Query timeseries points

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateInt("from",-62147425)
queryParams.UpdateInt("to",-62147425)
queryParams.UpdateString("query","tempor Ut sed velit")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/query",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "error": "officia dolor dolor enim Ut",
#   "from_date": 74851718,
#   "group_by": [
#     "Ut sint veniam voluptate id",
#     "laborum dolore fugiat quis"
#   ],
#   "message": "commodo Duis dolore",
#   "query": "irure nulla",
#   "res_type": "time_series",
#   "series": [
#     {
#       "aggr": "avg",
#       "display_name": "system.cpu.idle",
#       "end": 40693612,
#       "expression": "system.cpu.idle{host:foo,env:test}",
#       "interval": 40405386,
#       "length": -62156772,
#       "metric": "system.cpu.idle",
#       "pointlist": [
#         [
#           1681683300000,
#           77.62145685254418
#         ]
#       ],
#       "query_index": -41586801,
#       "scope": "host:foo,env:test",
#       "start": -45245073,
#       "tag_set": [
#         "aute incididunt enim",
#         "dolore mollit amet esse"
#       ],
#       "unit": [
#         {
#           "family": "time",
#           "name": "minute",
#           "plural": "minutes",
#           "scale_factor": 60,
#           "short_name": "min"
#         },
#         {
#           "family": "time",
#           "name": "minute",
#           "plural": "minutes",
#           "scale_factor": 60,
#           "short_name": "min"
#         }
#       ]
#     },
#     {
#       "aggr": "avg",
#       "display_name": "system.cpu.idle",
#       "end": -49813044,
#       "expression": "system.cpu.idle{host:foo,env:test}",
#       "interval": -86046844,
#       "length": 71311767,
#       "metric": "system.cpu.idle",
#       "pointlist": [
#         [
#           1681683300000,
#           77.62145685254418
#         ]
#       ],
#       "query_index": -70553970,
#       "scope": "host:foo,env:test",
#       "start": 3842833,
#       "tag_set": [
#         "sit enim consectetur",
#         "Duis"
#       ],
#       "unit": [
#         {
#           "family": "time",
#           "name": "minute",
#           "plural": "minutes",
#           "scale_factor": 60,
#           "short_name": "min"
#         },
#         {
#           "family": "time",
#           "name": "minute",
#           "plural": "minutes",
#           "scale_factor": 60,
#           "short_name": "min"
#         }
#       ]
#     }
#   ],
#   "status": "ok",
#   "to_date": 39411541
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

error = jResp.stringOf("error")
from_date = jResp.IntOf("from_date")
message = jResp.stringOf("message")
query = jResp.stringOf("query")
res_type = jResp.stringOf("res_type")
status = jResp.stringOf("status")
to_date = jResp.IntOf("to_date")
i = 0
count_i = jResp.SizeOfArray("group_by")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("group_by[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("series")
while i < count_i
    jResp.put_I(i)
    aggr = jResp.stringOf("series[i].aggr")
    display_name = jResp.stringOf("series[i].display_name")
    v_end = jResp.IntOf("series[i].end")
    expression = jResp.stringOf("series[i].expression")
    interval = jResp.IntOf("series[i].interval")
    length = jResp.IntOf("series[i].length")
    metric = jResp.stringOf("series[i].metric")
    query_index = jResp.IntOf("series[i].query_index")
    scope = jResp.stringOf("series[i].scope")
    start = jResp.IntOf("series[i].start")
    j = 0
    count_j = jResp.SizeOfArray("series[i].pointlist")
    while j < count_j
        jResp.put_J(j)
        k = 0
        count_k = jResp.SizeOfArray("series[i].pointlist[j]")
        while k < count_k
            jResp.put_K(k)
            intVal = jResp.IntOf("series[i].pointlist[j][k]")
            k = k + 1
        end
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("series[i].tag_set")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("series[i].tag_set[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("series[i].unit")
    while j < count_j
        jResp.put_J(j)
        family = jResp.stringOf("series[i].unit[j].family")
        name = jResp.stringOf("series[i].unit[j].name")
        plural = jResp.stringOf("series[i].unit[j].plural")
        scale_factor = jResp.IntOf("series[i].unit[j].scale_factor")
        short_name = jResp.stringOf("series[i].unit[j].short_name")
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl -G -d "from=-62147425"
	-d "to=-62147425"
	-d "query=tempor%20Ut%20sed%20velit"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/query

Postman Collection Item JSON

{
  "name": "Query timeseries points",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "query"
      ],
      "query": [
        {
          "key": "from",
          "value": "-62147425",
          "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
        },
        {
          "key": "to",
          "value": "-62147425",
          "description": "(Required) End of the queried time period, seconds since the Unix epoch."
        },
        {
          "key": "query",
          "value": "tempor Ut sed velit",
          "description": "(Required) Query string."
        }
      ]
    },
    "description": "Query timeseries points."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"error\": \"officia dolor dolor enim Ut\",\n  \"from_date\": 74851718,\n  \"group_by\": [\n    \"Ut sint veniam voluptate id\",\n    \"laborum dolore fugiat quis\"\n  ],\n  \"message\": \"commodo Duis dolore\",\n  \"query\": \"irure nulla\",\n  \"res_type\": \"time_series\",\n  \"series\": [\n    {\n      \"aggr\": \"avg\",\n      \"display_name\": \"system.cpu.idle\",\n      \"end\": 40693612,\n      \"expression\": \"system.cpu.idle{host:foo,env:test}\",\n      \"interval\": 40405386,\n      \"length\": -62156772,\n      \"metric\": \"system.cpu.idle\",\n      \"pointlist\": [\n        [\n          1681683300000,\n          77.62145685254418\n        ]\n      ],\n      \"query_index\": -41586801,\n      \"scope\": \"host:foo,env:test\",\n      \"start\": -45245073,\n      \"tag_set\": [\n        \"aute incididunt enim\",\n        \"dolore mollit amet esse\"\n      ],\n      \"unit\": [\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        },\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        }\n      ]\n    },\n    {\n      \"aggr\": \"avg\",\n      \"display_name\": \"system.cpu.idle\",\n      \"end\": -49813044,\n      \"expression\": \"system.cpu.idle{host:foo,env:test}\",\n      \"interval\": -86046844,\n      \"length\": 71311767,\n      \"metric\": \"system.cpu.idle\",\n      \"pointlist\": [\n        [\n          1681683300000,\n          77.62145685254418\n        ]\n      ],\n      \"query_index\": -70553970,\n      \"scope\": \"host:foo,env:test\",\n      \"start\": 3842833,\n      \"tag_set\": [\n        \"sit enim consectetur\",\n        \"Duis\"\n      ],\n      \"unit\": [\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        },\n        {\n          \"family\": \"time\",\n          \"name\": \"minute\",\n          \"plural\": \"minutes\",\n          \"scale_factor\": 60,\n          \"short_name\": \"min\"\n        }\n      ]\n    }\n  ],\n  \"status\": \"ok\",\n  \"to_date\": 39411541\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/query?from=-62147425&to=-62147425&query=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "query"
          ],
          "query": [
            {
              "key": "from",
              "value": "-62147425",
              "description": "(Required) Start of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "to",
              "value": "-62147425",
              "description": "(Required) End of the queried time period, seconds since the Unix epoch."
            },
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "(Required) Query string."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}