PureBasic / Datadog API Collection / List active tags and aggregations
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"window[seconds]","<long>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/active-configurations",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "attributes": {
; "active_aggregations": [
; {
; "time": "count",
; "space": "max"
; },
; {
; "time": "sum",
; "space": "min"
; }
; ],
; "active_tags": [
; "<string>",
; "<string>"
; ]
; },
; "id": "<string>",
; "type": "actively_queried_configurations"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
time.s
space.s
strVal.s
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"data.type")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.active_aggregations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
time = CkJsonObject::ckStringOf(jResp,"data.attributes.active_aggregations[i].time")
space = CkJsonObject::ckStringOf(jResp,"data.attributes.active_aggregations[i].space")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.active_tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.active_tags[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "window[seconds]=%3Clong%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/active-configurations
Postman Collection Item JSON
{
"name": "List active tags and aggregations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/active-configurations?window[seconds]=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "<long>",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name",
"value": "<string>"
}
]
},
"description": "List tags and aggregations that are actively queried on dashboards and monitors for a given metric name."
},
"response": [
{
"name": "Success",
"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/v2/metrics/:metric_name/active-configurations?window[seconds]=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "<long>",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"active_aggregations\": [\n {\n \"time\": \"count\",\n \"space\": \"max\"\n },\n {\n \"time\": \"sum\",\n \"space\": \"min\"\n }\n ],\n \"active_tags\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"actively_queried_configurations\"\n }\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/v2/metrics/:metric_name/active-configurations?window[seconds]=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "<long>",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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": "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/v2/metrics/:metric_name/active-configurations?window[seconds]=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "<long>",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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": "Not Found",
"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/v2/metrics/:metric_name/active-configurations?window[seconds]=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "<long>",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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": "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/v2/metrics/:metric_name/active-configurations?window[seconds]=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"active-configurations"
],
"query": [
{
"key": "window[seconds]",
"value": "<long>",
"description": "The number of seconds of look back (from now).\nDefault value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month)."
}
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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}"
}
]
}
