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.
// {
// "compute": [
// {
// "aggregation": "pc98",
// "interval": "<string>",
// "metric": "<string>",
// "type": "total"
// },
// {
// "aggregation": "cardinality",
// "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": "sum",
// "metric": "<string>",
// "order": "asc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// },
// {
// "facet": "<string>",
// "histogram": {
// "interval": "<double>",
// "min": "<double>",
// "max": "<double>"
// },
// "limit": 10,
// "missing": "<string>",
// "sort": {
// "aggregation": "pc99",
// "metric": "<string>",
// "order": "asc",
// "type": "alphabetical"
// },
// "total": "<boolean>"
// }
// ],
// "options": {
// "time_offset": "<long>",
// "timezone": "UTC"
// },
// "page": {
// "cursor": "<string>",
// "limit": 10
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("compute[0].aggregation","pc98")
loJson.UpdateString("compute[0].interval","<string>")
loJson.UpdateString("compute[0].metric","<string>")
loJson.UpdateString("compute[0].type","total")
loJson.UpdateString("compute[1].aggregation","cardinality")
loJson.UpdateString("compute[1].interval","<string>")
loJson.UpdateString("compute[1].metric","<string>")
loJson.UpdateString("compute[1].type","total")
loJson.UpdateString("filter.from","now-15m")
loJson.UpdateString("filter.query","*")
loJson.UpdateString("filter.to","now")
loJson.UpdateString("group_by[0].facet","<string>")
loJson.UpdateString("group_by[0].histogram.interval","<double>")
loJson.UpdateString("group_by[0].histogram.min","<double>")
loJson.UpdateString("group_by[0].histogram.max","<double>")
loJson.UpdateInt("group_by[0].limit",10)
loJson.UpdateString("group_by[0].missing","<string>")
loJson.UpdateString("group_by[0].sort.aggregation","sum")
loJson.UpdateString("group_by[0].sort.metric","<string>")
loJson.UpdateString("group_by[0].sort.order","asc")
loJson.UpdateString("group_by[0].sort.type","alphabetical")
loJson.UpdateString("group_by[0].total","<boolean>")
loJson.UpdateString("group_by[1].facet","<string>")
loJson.UpdateString("group_by[1].histogram.interval","<double>")
loJson.UpdateString("group_by[1].histogram.min","<double>")
loJson.UpdateString("group_by[1].histogram.max","<double>")
loJson.UpdateInt("group_by[1].limit",10)
loJson.UpdateString("group_by[1].missing","<string>")
loJson.UpdateString("group_by[1].sort.aggregation","pc99")
loJson.UpdateString("group_by[1].sort.metric","<string>")
loJson.UpdateString("group_by[1].sort.order","asc")
loJson.UpdateString("group_by[1].sort.type","alphabetical")
loJson.UpdateString("group_by[1].total","<boolean>")
loJson.UpdateString("options.time_offset","<long>")
loJson.UpdateString("options.timezone","UTC")
loJson.UpdateString("page.cursor","<string>")
loJson.UpdateInt("page.limit",10)
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v2/rum/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": {
// "buckets": [
// {
// "by": {
// "inc4": "<string>"
// },
// "computes": {
// "nostrud_0c_": "<string>"
// }
// },
// {
// "by": {
// "dolore__": "<string>",
// "aliqua_8a4": "<string>",
// "fugiatd": "<string>",
// "culpa9_a": "<string>"
// },
// "computes": {
// "aliqua_237": "<string>"
// }
// }
// ]
// },
// "links": {
// "next": "<string>"
// },
// "meta": {
// "elapsed": "<long>",
// "page": {
// "after": "<string>"
// },
// "request_id": "<string>",
// "status": "done",
// "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
lcV_Next = loJResp.StringOf("links.next")
lcElapsed = loJResp.StringOf("meta.elapsed")
lcAfter = loJResp.StringOf("meta.page.after")
lcRequest_id = loJResp.StringOf("meta.request_id")
lcStatus = loJResp.StringOf("meta.status")
i = 0
lnCount_i = loJResp.SizeOfArray("data.buckets")
do while i < lnCount_i
loJResp.I = i
lcInc4 = loJResp.StringOf("data.buckets[i].by.inc4")
lcNostrud_0c_ = loJResp.StringOf("data.buckets[i].computes.nostrud_0c_")
lcDolore__ = loJResp.StringOf("data.buckets[i].by.dolore__")
lcAliqua_8a4 = loJResp.StringOf("data.buckets[i].by.aliqua_8a4")
lcFugiatd = loJResp.StringOf("data.buckets[i].by.fugiatd")
lcCulpa9_a = loJResp.StringOf("data.buckets[i].by.culpa9_a")
lcAliqua_237 = loJResp.StringOf("data.buckets[i].computes.aliqua_237")
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 '{
"compute": [
{
"aggregation": "pc98",
"interval": "<string>",
"metric": "<string>",
"type": "total"
},
{
"aggregation": "cardinality",
"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": "sum",
"metric": "<string>",
"order": "asc",
"type": "alphabetical"
},
"total": "<boolean>"
},
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "pc99",
"metric": "<string>",
"order": "asc",
"type": "alphabetical"
},
"total": "<boolean>"
}
],
"options": {
"time_offset": "<long>",
"timezone": "UTC"
},
"page": {
"cursor": "<string>",
"limit": 10
}
}'
https://api.app.ddog-gov.com/api/v2/rum/analytics/aggregate
Postman Collection Item JSON
{
"name": "Aggregate RUM events",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compute\": [\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"cardinality\",\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\": \"sum\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\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\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries."
},
"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 \"compute\": [\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"cardinality\",\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\": \"sum\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\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\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"analytics",
"aggregate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"buckets\": [\n {\n \"by\": {\n \"inc4\": \"<string>\"\n },\n \"computes\": {\n \"nostrud_0c_\": \"<string>\"\n }\n },\n {\n \"by\": {\n \"dolore__\": \"<string>\",\n \"aliqua_8a4\": \"<string>\",\n \"fugiatd\": \"<string>\",\n \"culpa9_a\": \"<string>\"\n },\n \"computes\": {\n \"aliqua_237\": \"<string>\"\n }\n }\n ]\n },\n \"links\": {\n \"next\": \"<string>\"\n },\n \"meta\": {\n \"elapsed\": \"<long>\",\n \"page\": {\n \"after\": \"<string>\"\n },\n \"request_id\": \"<string>\",\n \"status\": \"done\",\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 \"compute\": [\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"cardinality\",\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\": \"sum\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\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\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"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": "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 \"compute\": [\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"cardinality\",\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\": \"sum\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\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\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"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 \"compute\": [\n {\n \"aggregation\": \"pc98\",\n \"interval\": \"<string>\",\n \"metric\": \"<string>\",\n \"type\": \"total\"\n },\n {\n \"aggregation\": \"cardinality\",\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\": \"sum\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\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\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"time_offset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/rum/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"rum",
"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}"
}
]
}
