Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Time
string ls_Space
string ls_StrVal
string ls_Created_at
string ls_Include_percentiles
string ls_Metric_type
string ls_Modified_at
string ls_Id
string ls_V_Type
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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": {
// "tags": [
// ],
// "metric_type": "gauge",
// "aggregations": [
// {
// "time": "count",
// "space": "max"
// },
// {
// "time": "max",
// "space": "min"
// }
// ],
// "include_percentiles": "<boolean>"
// }
// }
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateString("data.id","<string>")
loo_Json.UpdateString("data.type","manage_tags")
loo_Json.UpdateNewArray("data.attributes.tags")
loo_Json.UpdateString("data.attributes.metric_type","gauge")
loo_Json.UpdateString("data.attributes.aggregations[0].time","count")
loo_Json.UpdateString("data.attributes.aggregations[0].space","max")
loo_Json.UpdateString("data.attributes.aggregations[1].time","max")
loo_Json.UpdateString("data.attributes.aggregations[1].space","min")
loo_Json.UpdateString("data.attributes.include_percentiles","<boolean>")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.PostJson3("https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/tags","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Created_at = loo_JResp.StringOf("data.attributes.created_at")
ls_Include_percentiles = loo_JResp.StringOf("data.attributes.include_percentiles")
ls_Metric_type = loo_JResp.StringOf("data.attributes.metric_type")
ls_Modified_at = loo_JResp.StringOf("data.attributes.modified_at")
ls_Id = loo_JResp.StringOf("data.id")
ls_V_Type = loo_JResp.StringOf("data.type")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data.attributes.aggregations")
do while i < li_Count_i
loo_JResp.I = i
ls_Time = loo_JResp.StringOf("data.attributes.aggregations[i].time")
ls_Space = loo_JResp.StringOf("data.attributes.aggregations[i].space")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("data.attributes.tags")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("data.attributes.tags[i]")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "manage_tags",
"attributes": {
"tags": [],
"metric_type": "gauge",
"aggregations": [
{
"time": "count",
"space": "max"
},
{
"time": "max",
"space": "min"
}
],
"include_percentiles": "<boolean>"
}
}
}'
https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/tags
Postman Collection Item JSON
{
"name": "Create a tag configuration",
"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\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [],\n \"metric_type\": \"gauge\",\n \"aggregations\": [\n {\n \"time\": \"count\",\n \"space\": \"max\"\n },\n {\n \"time\": \"max\",\n \"space\": \"min\"\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": "Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.\nOptionally, include percentile aggregations on any distribution metric or configure custom aggregations\non any count, rate, or gauge metric.\nCan only be used with application keys of users with the `Manage Tags for Metrics` permission."
},
"response": [
{
"name": "Created",
"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\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [],\n \"metric_type\": \"gauge\",\n \"aggregations\": [\n {\n \"time\": \"count\",\n \"space\": \"max\"\n },\n {\n \"time\": \"max\",\n \"space\": \"min\"\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": "Created",
"code": 201,
"_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": "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\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [],\n \"metric_type\": \"gauge\",\n \"aggregations\": [\n {\n \"time\": \"count\",\n \"space\": \"max\"\n },\n {\n \"time\": \"max\",\n \"space\": \"min\"\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": "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\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [],\n \"metric_type\": \"gauge\",\n \"aggregations\": [\n {\n \"time\": \"count\",\n \"space\": \"max\"\n },\n {\n \"time\": \"max\",\n \"space\": \"min\"\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": "Conflict",
"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\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [],\n \"metric_type\": \"gauge\",\n \"aggregations\": [\n {\n \"time\": \"count\",\n \"space\": \"max\"\n },\n {\n \"time\": \"max\",\n \"space\": \"min\"\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": "Conflict",
"code": 409,
"_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\": \"manage_tags\",\n \"attributes\": {\n \"tags\": [],\n \"metric_type\": \"gauge\",\n \"aggregations\": [\n {\n \"time\": \"count\",\n \"space\": \"max\"\n },\n {\n \"time\": \"max\",\n \"space\": \"min\"\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}"
}
]
}
