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": {
; "type": "logs_metrics",
; "attributes": {
; "compute": {
; "include_percentiles": "<boolean>"
; },
; "filter": {
; "query": "*"
; },
; "group_by": [
; {
; "path": "<string>",
; "tag_name": "<string>"
; },
; {
; "path": "<string>",
; "tag_name": "<string>"
; }
; ]
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"data.type","logs_metrics")
CkJsonObject::ckUpdateString(json,"data.attributes.compute.include_percentiles","<boolean>")
CkJsonObject::ckUpdateString(json,"data.attributes.filter.query","*")
CkJsonObject::ckUpdateString(json,"data.attributes.group_by[0].path","<string>")
CkJsonObject::ckUpdateString(json,"data.attributes.group_by[0].tag_name","<string>")
CkJsonObject::ckUpdateString(json,"data.attributes.group_by[1].path","<string>")
CkJsonObject::ckUpdateString(json,"data.attributes.group_by[1].tag_name","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://api.app.ddog-gov.com/api/v2/logs/config/metrics/:metric_id",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
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(json)
CkStringBuilder::ckDispose(sbRequestBody)
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": {
; "compute": {
; "aggregation_type": "count",
; "include_percentiles": "<boolean>",
; "path": "<string>"
; },
; "filter": {
; "query": "<string>"
; },
; "group_by": [
; {
; "path": "<string>",
; "tag_name": "<string>"
; },
; {
; "path": "<string>",
; "tag_name": "<string>"
; }
; ]
; },
; "id": "<string>",
; "type": "logs_metrics"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
path.s
tag_name.s
Aggregation_type.s = CkJsonObject::ckStringOf(jResp,"data.attributes.compute.aggregation_type")
Include_percentiles.s = CkJsonObject::ckStringOf(jResp,"data.attributes.compute.include_percentiles")
Path.s = CkJsonObject::ckStringOf(jResp,"data.attributes.compute.path")
Query.s = CkJsonObject::ckStringOf(jResp,"data.attributes.filter.query")
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.group_by")
While i < count_i
CkJsonObject::setCkI(jResp, i)
path = CkJsonObject::ckStringOf(jResp,"data.attributes.group_by[i].path")
tag_name = CkJsonObject::ckStringOf(jResp,"data.attributes.group_by[i].tag_name")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "logs_metrics",
"attributes": {
"compute": {
"include_percentiles": "<boolean>"
},
"filter": {
"query": "*"
},
"group_by": [
{
"path": "<string>",
"tag_name": "<string>"
},
{
"path": "<string>",
"tag_name": "<string>"
}
]
}
}
}'
https://api.app.ddog-gov.com/api/v2/logs/config/metrics/:metric_id
Postman Collection Item JSON
{
"name": "Update a log-based metric",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": \"<boolean>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "<string>"
}
]
},
"description": "Update a specific log-based metric from your organization.\nReturns the log-based metric object from the request body when the request is successful."
},
"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 \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": \"<boolean>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\n },\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"logs_metrics\"\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 \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": \"<boolean>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"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": "Not Authorized",
"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 \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": \"<boolean>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"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": "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 \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": \"<boolean>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"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": "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 \"type\": \"logs_metrics\",\n \"attributes\": {\n \"compute\": {\n \"include_percentiles\": \"<boolean>\"\n },\n \"filter\": {\n \"query\": \"*\"\n },\n \"group_by\": [\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n },\n {\n \"path\": \"<string>\",\n \"tag_name\": \"<string>\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id"
}
]
}
},
"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}"
}
]
}
