TCL / Datadog API Collection / Query timeseries data across multiple products
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "data": {
# "type": "timeseries_request",
# "attributes": {
# "to": "<long>",
# "from": "<long>",
# "queries": [
# {
# "data_source": "metrics",
# "query": "<string>",
# "name": "<string>"
# },
# {
# "data_source": "metrics",
# "query": "<string>",
# "name": "<string>"
# }
# ],
# "formulas": [
# {
# "formula": "<string>",
# "limit": {
# "count": "<integer>",
# "order": "desc"
# }
# },
# {
# "formula": "<string>",
# "limit": {
# "count": "<integer>",
# "order": "desc"
# }
# }
# ],
# "interval": "<long>"
# }
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "data.type" "timeseries_request"
CkJsonObject_UpdateString $json "data.attributes.to" "<long>"
CkJsonObject_UpdateString $json "data.attributes.from" "<long>"
CkJsonObject_UpdateString $json "data.attributes.queries[0].data_source" "metrics"
CkJsonObject_UpdateString $json "data.attributes.queries[0].query" "<string>"
CkJsonObject_UpdateString $json "data.attributes.queries[0].name" "<string>"
CkJsonObject_UpdateString $json "data.attributes.queries[1].data_source" "metrics"
CkJsonObject_UpdateString $json "data.attributes.queries[1].query" "<string>"
CkJsonObject_UpdateString $json "data.attributes.queries[1].name" "<string>"
CkJsonObject_UpdateString $json "data.attributes.formulas[0].formula" "<string>"
CkJsonObject_UpdateString $json "data.attributes.formulas[0].limit.count" "<integer>"
CkJsonObject_UpdateString $json "data.attributes.formulas[0].limit.order" "desc"
CkJsonObject_UpdateString $json "data.attributes.formulas[1].formula" "<string>"
CkJsonObject_UpdateString $json "data.attributes.formulas[1].limit.count" "<integer>"
CkJsonObject_UpdateString $json "data.attributes.formulas[1].limit.order" "desc"
CkJsonObject_UpdateString $json "data.attributes.interval" "<long>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.app.ddog-gov.com/api/v2/query/timeseries" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": {
# "attributes": {
# "series": [
# {
# "group_tags": [
# "<string>",
# "<string>"
# ],
# "query_index": "<integer>",
# "unit": [
# {
# "family": "<string>",
# "name": "<string>",
# "plural": "<string>",
# "scale_factor": "<double>",
# "short_name": "<string>"
# },
# {
# "family": "<string>",
# "name": "<string>",
# "plural": "<string>",
# "scale_factor": "<double>",
# "short_name": "<string>"
# }
# ]
# },
# {
# "group_tags": [
# "<string>",
# "<string>"
# ],
# "query_index": "<integer>",
# "unit": [
# {
# "family": "<string>",
# "name": "<string>",
# "plural": "<string>",
# "scale_factor": "<double>",
# "short_name": "<string>"
# },
# {
# "family": "<string>",
# "name": "<string>",
# "plural": "<string>",
# "scale_factor": "<double>",
# "short_name": "<string>"
# }
# ]
# }
# ],
# "times": [
# "<long>",
# "<long>"
# ],
# "values": [
# [
# "<double>",
# "<double>"
# ],
# [
# "<double>",
# "<double>"
# ]
# ]
# },
# "type": "timeseries_response"
# },
# "errors": "<string>"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set v_Type [CkJsonObject_stringOf $jResp "data.type"]
set errors [CkJsonObject_stringOf $jResp "errors"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.attributes.series"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set query_index [CkJsonObject_stringOf $jResp "data.attributes.series[i].query_index"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data.attributes.series[i].group_tags"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data.attributes.series[i].group_tags[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data.attributes.series[i].unit"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set family [CkJsonObject_stringOf $jResp "data.attributes.series[i].unit[j].family"]
set name [CkJsonObject_stringOf $jResp "data.attributes.series[i].unit[j].name"]
set plural [CkJsonObject_stringOf $jResp "data.attributes.series[i].unit[j].plural"]
set scale_factor [CkJsonObject_stringOf $jResp "data.attributes.series[i].unit[j].scale_factor"]
set short_name [CkJsonObject_stringOf $jResp "data.attributes.series[i].unit[j].short_name"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.attributes.times"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "data.attributes.times[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.attributes.values"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data.attributes.values[i]"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data.attributes.values[i][j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "timeseries_request",
"attributes": {
"to": "<long>",
"from": "<long>",
"queries": [
{
"data_source": "metrics",
"query": "<string>",
"name": "<string>"
},
{
"data_source": "metrics",
"query": "<string>",
"name": "<string>"
}
],
"formulas": [
{
"formula": "<string>",
"limit": {
"count": "<integer>",
"order": "desc"
}
},
{
"formula": "<string>",
"limit": {
"count": "<integer>",
"order": "desc"
}
}
],
"interval": "<long>"
}
}
}'
https://api.app.ddog-gov.com/api/v2/query/timeseries
Postman Collection Item JSON
{
"name": "Query timeseries data across multiple products",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
},
"description": "Query timeseries data across various data sources and\nprocess the data by applying formulas and functions."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"series\": [\n {\n \"group_tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"query_index\": \"<integer>\",\n \"unit\": [\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n },\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n }\n ]\n },\n {\n \"group_tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"query_index\": \"<integer>\",\n \"unit\": [\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n },\n {\n \"family\": \"<string>\",\n \"name\": \"<string>\",\n \"plural\": \"<string>\",\n \"scale_factor\": \"<double>\",\n \"short_name\": \"<string>\"\n }\n ]\n }\n ],\n \"times\": [\n \"<long>\",\n \"<long>\"\n ],\n \"values\": [\n [\n \"<double>\",\n \"<double>\"\n ],\n [\n \"<double>\",\n \"<double>\"\n ]\n ]\n },\n \"type\": \"timeseries_response\"\n },\n \"errors\": \"<string>\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"timeseries_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ],\n \"interval\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/timeseries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"timeseries"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
