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_Path
string ls_Tag_name
string ls_Aggregation_type
string ls_Include_percentiles
string ls_Path
string ls_Query
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
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.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": "spans_metrics",
// "attributes": {
// "compute": {
// "aggregation_type": "count",
// "include_percentiles": "<boolean>",
// "path": "<string>"
// },
// "filter": {
// "query": "*"
// },
// "group_by": [
// {
// "path": "<string>",
// "tag_name": "<string>"
// },
// {
// "path": "<string>",
// "tag_name": "<string>"
// }
// ]
// }
// }
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("data.id","<string>")
loo_Json.UpdateString("data.type","spans_metrics")
loo_Json.UpdateString("data.attributes.compute.aggregation_type","count")
loo_Json.UpdateString("data.attributes.compute.include_percentiles","<boolean>")
loo_Json.UpdateString("data.attributes.compute.path","<string>")
loo_Json.UpdateString("data.attributes.filter.query","*")
loo_Json.UpdateString("data.attributes.group_by[0].path","<string>")
loo_Json.UpdateString("data.attributes.group_by[0].tag_name","<string>")
loo_Json.UpdateString("data.attributes.group_by[1].path","<string>")
loo_Json.UpdateString("data.attributes.group_by[1].tag_name","<string>")
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/apm/config/metrics","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
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.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": {
// "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
ls_Aggregation_type = loo_JResp.StringOf("data.attributes.compute.aggregation_type")
ls_Include_percentiles = loo_JResp.StringOf("data.attributes.compute.include_percentiles")
ls_Path = loo_JResp.StringOf("data.attributes.compute.path")
ls_Query = loo_JResp.StringOf("data.attributes.filter.query")
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.group_by")
do while i < li_Count_i
loo_JResp.I = i
ls_Path = loo_JResp.StringOf("data.attributes.group_by[i].path")
ls_Tag_name = loo_JResp.StringOf("data.attributes.group_by[i].tag_name")
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": "spans_metrics",
"attributes": {
"compute": {
"aggregation_type": "count",
"include_percentiles": "<boolean>",
"path": "<string>"
},
"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
Postman Collection Item JSON
{
"name": "Create a span-based metric",
"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\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
},
"description": "Create a metric based on your ingested spans in your organization.\nReturns the span-based metric object from the request body when the request is successful."
},
"response": [
{
"name": "OK",
"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\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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": "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\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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": "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\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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\": \"spans_metrics\",\n \"attributes\": {\n \"compute\": {\n \"aggregation_type\": \"count\",\n \"include_percentiles\": \"<boolean>\",\n \"path\": \"<string>\"\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"metrics"
]
}
},
"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}"
}
]
}
