Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
// 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": "spans_metrics",
// "attributes": {
// "compute": {
// "include_percentiles": "<boolean>"
// },
// "filter": {
// "query": "*"
// },
// "group_by": [
// {
// "path": "<string>",
// "tag_name": "<string>"
// },
// {
// "path": "<string>",
// "tag_name": "<string>"
// }
// ]
// }
// }
// }
let json = CkoJsonObject()
json.UpdateString("data.type", value: "spans_metrics")
json.UpdateString("data.attributes.compute.include_percentiles", value: "<boolean>")
json.UpdateString("data.attributes.filter.query", value: "*")
json.UpdateString("data.attributes.group_by[0].path", value: "<string>")
json.UpdateString("data.attributes.group_by[0].tag_name", value: "<string>")
json.UpdateString("data.attributes.group_by[1].path", value: "<string>")
json.UpdateString("data.attributes.group_by[1].tag_name", value: "<string>")
http.SetRequestHeader("Content-Type", value: "application/json")
http.SetRequestHeader("Accept", value: "application/json")
let sbRequestBody = CkoStringBuilder()
json.EmitSb(sbRequestBody)
var resp: CkoHttpResponse? = http.PTextSb("PATCH", url: "https://api.app.ddog-gov.com/api/v2/apm/config/metrics/:metric_id", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "compute": {
// "aggregation_type": "distribution",
// "include_percentiles": "<boolean>",
// "path": "<string>"
// },
// "filter": {
// "query": "<string>"
// },
// "group_by": [
// {
// "path": "<string>",
// "tag_name": "<string>"
// },
// {
// "path": "<string>",
// "tag_name": "<string>"
// }
// ]
// },
// "id": "<string>",
// "type": "spans_metrics"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var path: String?
var tag_name: String?
var Aggregation_type: String? = jResp.StringOf("data.attributes.compute.aggregation_type")
var Include_percentiles: String? = jResp.StringOf("data.attributes.compute.include_percentiles")
var Path: String? = jResp.StringOf("data.attributes.compute.path")
var Query: String? = jResp.StringOf("data.attributes.filter.query")
var Id: String? = jResp.StringOf("data.id")
var v_Type: String? = jResp.StringOf("data.type")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("data.attributes.group_by").intValue
while i < count_i {
jResp.I = i
path = jResp.StringOf("data.attributes.group_by[i].path")
tag_name = jResp.StringOf("data.attributes.group_by[i].tag_name")
i = i + 1
}
}
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "spans_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/apm/config/metrics/:metric_id
Postman Collection Item JSON
{
"name": "Update a span-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\": \"spans_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/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics",
":metric_id"
],
"variable": [
{
"key": "metric_id",
"value": "<string>"
}
]
},
"description": "Update a specific span-based metric from your organization.\nReturns the span-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\": \"spans_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/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"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\": \"distribution\",\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\": \"spans_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\": \"spans_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/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"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\": \"spans_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/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"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\": \"spans_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/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"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\": \"spans_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/apm/config/metrics/:metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"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}"
}
]
}
