Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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": {
// "attributes": {
// "compute": [
// {
// "aggregation": "avg",
// "interval": "<string>",
// "metric": "<string>",
// "type": "total"
// },
// {
// "aggregation": "pc98",
// "interval": "<string>",
// "metric": "<string>",
// "type": "total"
// }
// ],
// "filter": {
// "from": "now-15m",
// "query": "*",
// "to": "now"
// },
// "group_by": [
// {
// "facet": "<string>",
// "histogram": {
// "interval": "<double>",
// "min": "<double>",
// "max": "<double>"
// },
// "limit": 10,
// "missing": "<string>",
// "sort": {
// "aggregation": "count",
// "metric": "<string>",
// "order": "desc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// },
// {
// "facet": "<string>",
// "histogram": {
// "interval": "<double>",
// "min": "<double>",
// "max": "<double>"
// },
// "limit": 10,
// "missing": "<string>",
// "sort": {
// "aggregation": "pc99",
// "metric": "<string>",
// "order": "desc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// }
// ],
// "options": {
// "timeOffset": "<long>",
// "timezone": "UTC"
// }
// },
// "type": "aggregate_request"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("data.attributes.compute[0].aggregation","avg")
loJson.UpdateString("data.attributes.compute[0].interval","<string>")
loJson.UpdateString("data.attributes.compute[0].metric","<string>")
loJson.UpdateString("data.attributes.compute[0].type","total")
loJson.UpdateString("data.attributes.compute[1].aggregation","pc98")
loJson.UpdateString("data.attributes.compute[1].interval","<string>")
loJson.UpdateString("data.attributes.compute[1].metric","<string>")
loJson.UpdateString("data.attributes.compute[1].type","total")
loJson.UpdateString("data.attributes.filter.from","now-15m")
loJson.UpdateString("data.attributes.filter.query","*")
loJson.UpdateString("data.attributes.filter.to","now")
loJson.UpdateString("data.attributes.group_by[0].facet","<string>")
loJson.UpdateString("data.attributes.group_by[0].histogram.interval","<double>")
loJson.UpdateString("data.attributes.group_by[0].histogram.min","<double>")
loJson.UpdateString("data.attributes.group_by[0].histogram.max","<double>")
loJson.UpdateInt("data.attributes.group_by[0].limit",10)
loJson.UpdateString("data.attributes.group_by[0].missing","<string>")
loJson.UpdateString("data.attributes.group_by[0].sort.aggregation","count")
loJson.UpdateString("data.attributes.group_by[0].sort.metric","<string>")
loJson.UpdateString("data.attributes.group_by[0].sort.order","desc")
loJson.UpdateString("data.attributes.group_by[0].sort.type","alphabetical")
loJson.UpdateString("data.attributes.group_by[0].total","<boolean>")
loJson.UpdateString("data.attributes.group_by[1].facet","<string>")
loJson.UpdateString("data.attributes.group_by[1].histogram.interval","<double>")
loJson.UpdateString("data.attributes.group_by[1].histogram.min","<double>")
loJson.UpdateString("data.attributes.group_by[1].histogram.max","<double>")
loJson.UpdateInt("data.attributes.group_by[1].limit",10)
loJson.UpdateString("data.attributes.group_by[1].missing","<string>")
loJson.UpdateString("data.attributes.group_by[1].sort.aggregation","pc99")
loJson.UpdateString("data.attributes.group_by[1].sort.metric","<string>")
loJson.UpdateString("data.attributes.group_by[1].sort.order","desc")
loJson.UpdateString("data.attributes.group_by[1].sort.type","alphabetical")
loJson.UpdateString("data.attributes.group_by[1].total","<boolean>")
loJson.UpdateString("data.attributes.options.timeOffset","<long>")
loJson.UpdateString("data.attributes.options.timezone","UTC")
loJson.UpdateString("data.type","aggregate_request")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v2/spans/analytics/aggregate","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "attributes": {
// "by": {
// "ea3": {
// "description": "The values for each group by."
// },
// "nulla_7fe": {
// "description": "The values for each group by."
// }
// },
// "compute": {},
// "computes": {
// "ullamco_2f": "<string>",
// "do_fc0": "<string>"
// }
// },
// "id": "<string>",
// "type": "bucket"
// },
// {
// "attributes": {
// "by": {
// "nisi9a": {
// "description": "The values for each group by."
// }
// },
// "compute": {},
// "computes": {
// "sunt_d": "<string>",
// "elit_d4": "<string>"
// }
// },
// "id": "<string>",
// "type": "bucket"
// }
// ],
// "meta": {
// "elapsed": "<long>",
// "request_id": "<string>",
// "status": "timeout",
// "warnings": [
// {
// "code": "<string>",
// "detail": "<string>",
// "title": "<string>"
// },
// {
// "code": "<string>",
// "detail": "<string>",
// "title": "<string>"
// }
// ]
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcElapsed = loJResp.StringOf("meta.elapsed")
lcRequest_id = loJResp.StringOf("meta.request_id")
lcStatus = loJResp.StringOf("meta.status")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
loJResp.I = i
lcDescription = loJResp.StringOf("data[i].attributes.by.ea3.description")
lcNulla_7feDescription = loJResp.StringOf("data[i].attributes.by.nulla_7fe.description")
lcUllamco_2f = loJResp.StringOf("data[i].attributes.computes.ullamco_2f")
lcDo_fc0 = loJResp.StringOf("data[i].attributes.computes.do_fc0")
lcId = loJResp.StringOf("data[i].id")
lcV_type = loJResp.StringOf("data[i].type")
lcNisi9aDescription = loJResp.StringOf("data[i].attributes.by.nisi9a.description")
lcSunt_d = loJResp.StringOf("data[i].attributes.computes.sunt_d")
lcElit_d4 = loJResp.StringOf("data[i].attributes.computes.elit_d4")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("meta.warnings")
do while i < lnCount_i
loJResp.I = i
lcCode = loJResp.StringOf("meta.warnings[i].code")
lcDetail = loJResp.StringOf("meta.warnings[i].detail")
lcTitle = loJResp.StringOf("meta.warnings[i].title")
i = i + 1
enddo
release loHttp
release loJson
release loSbResponseBody
release loJResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"compute": [
{
"aggregation": "avg",
"interval": "<string>",
"metric": "<string>",
"type": "total"
},
{
"aggregation": "pc98",
"interval": "<string>",
"metric": "<string>",
"type": "total"
}
],
"filter": {
"from": "now-15m",
"query": "*",
"to": "now"
},
"group_by": [
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "count",
"metric": "<string>",
"order": "desc",
"type": "alphabetical"
},
"total": "<boolean>"
},
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "pc99",
"metric": "<string>",
"order": "desc",
"type": "alphabetical"
},
"total": "<boolean>"
}
],
"options": {
"timeOffset": "<long>",
"timezone": "UTC"
}
},
"type": "aggregate_request"
}
}'
https://api.app.ddog-gov.com/api/v2/spans/analytics/aggregate
Postman Collection Item JSON
{
"name": "Aggregate spans",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate spans into buckets and compute metrics and timeseries.\nThis endpoint is rate limited to `300` requests per hour."
},
"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 \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"by\": {\n \"ea3\": {\n \"description\": \"The values for each group by.\"\n },\n \"nulla_7fe\": {\n \"description\": \"The values for each group by.\"\n }\n },\n \"compute\": {},\n \"computes\": {\n \"ullamco_2f\": \"<string>\",\n \"do_fc0\": \"<string>\"\n }\n },\n \"id\": \"<string>\",\n \"type\": \"bucket\"\n },\n {\n \"attributes\": {\n \"by\": {\n \"nisi9a\": {\n \"description\": \"The values for each group by.\"\n }\n },\n \"compute\": {},\n \"computes\": {\n \"sunt_d\": \"<string>\",\n \"elit_d4\": \"<string>\"\n }\n },\n \"id\": \"<string>\",\n \"type\": \"bucket\"\n }\n ],\n \"meta\": {\n \"elapsed\": \"<long>\",\n \"request_id\": \"<string>\",\n \"status\": \"timeout\",\n \"warnings\": [\n {\n \"code\": \"<string>\",\n \"detail\": \"<string>\",\n \"title\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"detail\": \"<string>\",\n \"title\": \"<string>\"\n }\n ]\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 \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"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 \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"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": "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 \"attributes\": {\n \"compute\": [\n {\n \"aggregation\": \"avg\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n }\n ],\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"group_by\": [\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"count\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n },\n {\n \"facet\": \"<string>\",\n \"histogram\": {\n \"interval\": \"<double>\",\n \"min\": \"<double>\",\n \"max\": \"<double>\"\n },\n \"limit\": 10,\n \"missing\": \"<string>\",\n \"sort\": {\n \"aggregation\": \"pc99\",\n \"metric\": \"<string>\",\n \"order\": \"desc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n }\n },\n \"type\": \"aggregate_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"analytics",
"aggregate"
]
}
},
"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}"
}
]
}
