Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
time: PWideChar;
space: PWideChar;
strVal: PWideChar;
Created_at: PWideChar;
Include_percentiles: PWideChar;
Metric_type: PWideChar;
Modified_at: PWideChar;
Id: PWideChar;
v_Type: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// 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>"
// }
// }
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'data.id','<string>');
CkJsonObject_UpdateString(json,'data.type','manage_tags');
CkJsonObject_UpdateString(json,'data.attributes.aggregations[0].time','avg');
CkJsonObject_UpdateString(json,'data.attributes.aggregations[0].space','max');
CkJsonObject_UpdateString(json,'data.attributes.aggregations[1].time','count');
CkJsonObject_UpdateString(json,'data.attributes.aggregations[1].space','sum');
CkJsonObject_UpdateString(json,'data.attributes.include_percentiles','<boolean>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Accept','application/json');
sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp := CkHttp_PTextSb(http,'PATCH','https://api.app.ddog-gov.com/api/v2/metrics/:metric_name/tags',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
Created_at := CkJsonObject__stringOf(jResp,'data.attributes.created_at');
Include_percentiles := CkJsonObject__stringOf(jResp,'data.attributes.include_percentiles');
Metric_type := CkJsonObject__stringOf(jResp,'data.attributes.metric_type');
Modified_at := CkJsonObject__stringOf(jResp,'data.attributes.modified_at');
Id := CkJsonObject__stringOf(jResp,'data.id');
v_Type := CkJsonObject__stringOf(jResp,'data.type');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.attributes.aggregations');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
time := CkJsonObject__stringOf(jResp,'data.attributes.aggregations[i].time');
space := CkJsonObject__stringOf(jResp,'data.attributes.aggregations[i].space');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.attributes.tags');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'data.attributes.tags[i]');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
