Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("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": {
// "id": "<string>",
// "type": "manage_tags",
// "attributes": {
// "aggregations": [
// {
// "time": "avg",
// "space": "max"
// },
// {
// "time": "count",
// "space": "sum"
// }
// ],
// "include_percentiles": "<boolean>"
// }
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("data.id","<string>")
loJson.UpdateString("data.type","manage_tags")
loJson.UpdateString("data.attributes.aggregations[0].time","avg")
loJson.UpdateString("data.attributes.aggregations[0].space","max")
loJson.UpdateString("data.attributes.aggregations[1].time","count")
loJson.UpdateString("data.attributes.aggregations[1].space","sum")
loJson.UpdateString("data.attributes.include_percentiles","<boolean>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/tags",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "aggregations": [
// {
// "time": "avg",
// "space": "avg"
// },
// {
// "time": "count",
// "space": "min"
// }
// ],
// "created_at": "<dateTime>",
// "include_percentiles": "<boolean>",
// "metric_type": "gauge",
// "modified_at": "<dateTime>",
// "tags": [
// "<string>",
// "<string>"
// ]
// },
// "id": "<string>",
// "type": "manage_tags"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcCreated_at = loJResp.StringOf("data.attributes.created_at")
lcInclude_percentiles = loJResp.StringOf("data.attributes.include_percentiles")
lcMetric_type = loJResp.StringOf("data.attributes.metric_type")
lcModified_at = loJResp.StringOf("data.attributes.modified_at")
lcId = loJResp.StringOf("data.id")
lcV_Type = loJResp.StringOf("data.type")
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.aggregations")
do while i < lnCount_i
loJResp.I = i
lcTime = loJResp.StringOf("data.attributes.aggregations[i].time")
lcSpace = loJResp.StringOf("data.attributes.aggregations[i].space")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.tags")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("data.attributes.tags[i]")
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "manage_tags",
"attributes": {
"aggregations": [
{
"time": "avg",
"space": "max"
},
{
"time": "count",
"space": "sum"
}
],
"include_percentiles": "<boolean>"
}
}
}'
https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/tags
Postman Collection Item JSON
{
"name": "Update a tag configuration",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"time\": \"avg\",\n \"space\": \"max\"\n },\n {\n \"time\": \"count\",\n \"space\": \"sum\"\n }\n ],\n \"include_percentiles\": \"<boolean>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name",
"value": "<string>"
}
]
},
"description": "Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations\nof a count, rate, or gauge metric.\nCan only be used with application keys from users with the `Manage Tags for Metrics` permission."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"time\": \"avg\",\n \"space\": \"max\"\n },\n {\n \"time\": \"count\",\n \"space\": \"sum\"\n }\n ],\n \"include_percentiles\": \"<boolean>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"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 \"aggregations\": [\n {\n \"time\": \"avg\",\n \"space\": \"avg\"\n },\n {\n \"time\": \"count\",\n \"space\": \"min\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"include_percentiles\": \"<boolean>\",\n \"metric_type\": \"gauge\",\n \"modified_at\": \"<dateTime>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"manage_tags\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"time\": \"avg\",\n \"space\": \"max\"\n },\n {\n \"time\": \"count\",\n \"space\": \"sum\"\n }\n ],\n \"include_percentiles\": \"<boolean>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"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": "PATCH",
"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\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"time\": \"avg\",\n \"space\": \"max\"\n },\n {\n \"time\": \"count\",\n \"space\": \"sum\"\n }\n ],\n \"include_percentiles\": \"<boolean>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"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": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"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\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"time\": \"avg\",\n \"space\": \"max\"\n },\n {\n \"time\": \"count\",\n \"space\": \"sum\"\n }\n ],\n \"include_percentiles\": \"<boolean>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_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": "PATCH",
"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\": \"manage_tags\",\n \"attributes\": {\n \"aggregations\": [\n {\n \"time\": \"avg\",\n \"space\": \"max\"\n },\n {\n \"time\": \"count\",\n \"space\": \"sum\"\n }\n ],\n \"include_percentiles\": \"<boolean>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/metrics/:metric_name/tags",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"metrics",
":metric_name",
"tags"
],
"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}"
}
]
}
