PureBasic / Datadog API Collection / Configure tags for multiple metrics
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
; 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": {
; "id": "<string>",
; "type": "metric_bulk_configure_tags",
; "attributes": {
; "emails": [
; "<email>",
; "<email>"
; ],
; "tags": [
; "ciUburHZ",
; "sdur9"
; ]
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"data.id","<string>")
CkJsonObject::ckUpdateString(json,"data.type","metric_bulk_configure_tags")
CkJsonObject::ckUpdateString(json,"data.attributes.emails[0]","<email>")
CkJsonObject::ckUpdateString(json,"data.attributes.emails[1]","<email>")
CkJsonObject::ckUpdateString(json,"data.attributes.tags[0]","ciUburHZ")
CkJsonObject::ckUpdateString(json,"data.attributes.tags[1]","sdur9")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://api.app.ddog-gov.com/api/v2/metrics/config/bulk-tags",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
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."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "id": "<string>",
; "type": "metric_bulk_configure_tags",
; "attributes": {
; "emails": [
; "<email>",
; "<email>"
; ],
; "status": "<string>",
; "tags": [
; "fp",
; "a4-3mS"
; ]
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"data.type")
Status.s = CkJsonObject::ckStringOf(jResp,"data.attributes.status")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.emails")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.emails[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.tags[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "metric_bulk_configure_tags",
"attributes": {
"emails": [
"<email>",
"<email>"
],
"tags": [
"ciUburHZ",
"sdur9"
]
}
}
}'
https://api.app.ddog-gov.com/api/v2/metrics/config/bulk-tags
Postman Collection Item JSON
{
"name": "Configure tags for multiple metrics",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"<email>\",\n \"<email>\"\n ],\n \"tags\": [\n \"ciUburHZ\",\n \"sdur9\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
},
"description": "Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.\nMetrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.\nResults can be sent to a set of account email addresses, just like the same operation in the Datadog web app.\nIf multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not\nexpect deterministic ordering of concurrent calls.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission."
},
"response": [
{
"name": "Accepted",
"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 \"id\": \"<string>\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"<email>\",\n \"<email>\"\n ],\n \"tags\": [\n \"ciUburHZ\",\n \"sdur9\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"<email>\",\n \"<email>\"\n ],\n \"status\": \"<string>\",\n \"tags\": [\n \"fp\",\n \"a4-3mS\"\n ]\n }\n }\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 \"id\": \"<string>\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"<email>\",\n \"<email>\"\n ],\n \"tags\": [\n \"ciUburHZ\",\n \"sdur9\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"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": "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 \"id\": \"<string>\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"<email>\",\n \"<email>\"\n ],\n \"tags\": [\n \"ciUburHZ\",\n \"sdur9\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"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": "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 \"id\": \"<string>\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"<email>\",\n \"<email>\"\n ],\n \"tags\": [\n \"ciUburHZ\",\n \"sdur9\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"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": "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 \"id\": \"<string>\",\n \"type\": \"metric_bulk_configure_tags\",\n \"attributes\": {\n \"emails\": [\n \"<email>\",\n \"<email>\"\n ],\n \"tags\": [\n \"ciUburHZ\",\n \"sdur9\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/config/bulk-tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
"config",
"bulk-tags"
]
}
},
"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}"
}
]
}
