Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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": "cardinality",
; "interval": "<string>",
; "metric": "<string>",
; "type": "total"
; },
; {
; "aggregation": "cardinality",
; "interval": "<string>",
; "metric": "<string>",
; "type": "total"
; }
; ],
; "filter": {
; "from": "now-15m",
; "indexes": [
; "*"
; ],
; "query": "*",
; "storage_tier": "indexes",
; "to": "now"
; },
; "group_by": [
; {
; "facet": "<string>",
; "histogram": {
; "interval": "<double>",
; "min": "<double>",
; "max": "<double>"
; },
; "limit": 10,
; "missing": "<string>",
; "sort": {
; "aggregation": "median",
; "metric": "<string>",
; "order": "asc",
; "type": "alphabetical"
; },
; "total": "<boolean>"
; },
; {
; "facet": "<string>",
; "histogram": {
; "interval": "<double>",
; "min": "<double>",
; "max": "<double>"
; },
; "limit": 10,
; "missing": "<string>",
; "sort": {
; "aggregation": "cardinality",
; "metric": "<string>",
; "order": "asc",
; "type": "alphabetical"
; },
; "total": "<boolean>"
; }
; ],
; "options": {
; "timeOffset": "<long>",
; "timezone": "UTC"
; },
; "page": {
; "cursor": "<string>"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("compute[0].aggregation","cardinality")
$oJson.UpdateString("compute[0].interval","<string>")
$oJson.UpdateString("compute[0].metric","<string>")
$oJson.UpdateString("compute[0].type","total")
$oJson.UpdateString("compute[1].aggregation","cardinality")
$oJson.UpdateString("compute[1].interval","<string>")
$oJson.UpdateString("compute[1].metric","<string>")
$oJson.UpdateString("compute[1].type","total")
$oJson.UpdateString("filter.from","now-15m")
$oJson.UpdateString("filter.indexes[0]","*")
$oJson.UpdateString("filter.query","*")
$oJson.UpdateString("filter.storage_tier","indexes")
$oJson.UpdateString("filter.to","now")
$oJson.UpdateString("group_by[0].facet","<string>")
$oJson.UpdateString("group_by[0].histogram.interval","<double>")
$oJson.UpdateString("group_by[0].histogram.min","<double>")
$oJson.UpdateString("group_by[0].histogram.max","<double>")
$oJson.UpdateInt("group_by[0].limit",10)
$oJson.UpdateString("group_by[0].missing","<string>")
$oJson.UpdateString("group_by[0].sort.aggregation","median")
$oJson.UpdateString("group_by[0].sort.metric","<string>")
$oJson.UpdateString("group_by[0].sort.order","asc")
$oJson.UpdateString("group_by[0].sort.type","alphabetical")
$oJson.UpdateString("group_by[0].total","<boolean>")
$oJson.UpdateString("group_by[1].facet","<string>")
$oJson.UpdateString("group_by[1].histogram.interval","<double>")
$oJson.UpdateString("group_by[1].histogram.min","<double>")
$oJson.UpdateString("group_by[1].histogram.max","<double>")
$oJson.UpdateInt("group_by[1].limit",10)
$oJson.UpdateString("group_by[1].missing","<string>")
$oJson.UpdateString("group_by[1].sort.aggregation","cardinality")
$oJson.UpdateString("group_by[1].sort.metric","<string>")
$oJson.UpdateString("group_by[1].sort.order","asc")
$oJson.UpdateString("group_by[1].sort.type","alphabetical")
$oJson.UpdateString("group_by[1].total","<boolean>")
$oJson.UpdateString("options.timeOffset","<long>")
$oJson.UpdateString("options.timezone","UTC")
$oJson.UpdateString("page.cursor","<string>")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.PostJson3("https://api.app.ddog-gov.com/api/v2/logs/analytics/aggregate","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "buckets": [
; {
; "by": {
; "in__11": {
; "description": "The values for each group by"
; },
; "magna_c7": {
; "description": "The values for each group by"
; }
; },
; "computes": {
; "id_3": "<string>"
; }
; },
; {
; "by": {
; "cillum_d9": {
; "description": "The values for each group by"
; },
; "est_ec": {
; "description": "The values for each group by"
; },
; "in_5a4": {
; "description": "The values for each group by"
; }
; },
; "computes": {
; "ex_b": "<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
Local $sDescription
Local $sMagna_c7Description
Local $sId_3
Local $sCillum_d9Description
Local $sEst_ecDescription
Local $sIn_5a4Description
Local $sEx_b
Local $sCode
Local $sDetail
Local $sTitle
Local $sElapsed = $oJResp.StringOf("meta.elapsed")
Local $sAfter = $oJResp.StringOf("meta.page.after")
Local $sRequest_id = $oJResp.StringOf("meta.request_id")
Local $sStatus = $oJResp.StringOf("meta.status")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.buckets")
While $i < $iCount_i
$oJResp.I = $i
$sDescription = $oJResp.StringOf("data.buckets[i].by.in__11.description")
$sMagna_c7Description = $oJResp.StringOf("data.buckets[i].by.magna_c7.description")
$sId_3 = $oJResp.StringOf("data.buckets[i].computes.id_3")
$sCillum_d9Description = $oJResp.StringOf("data.buckets[i].by.cillum_d9.description")
$sEst_ecDescription = $oJResp.StringOf("data.buckets[i].by.est_ec.description")
$sIn_5a4Description = $oJResp.StringOf("data.buckets[i].by.in_5a4.description")
$sEx_b = $oJResp.StringOf("data.buckets[i].computes.ex_b")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("meta.warnings")
While $i < $iCount_i
$oJResp.I = $i
$sCode = $oJResp.StringOf("meta.warnings[i].code")
$sDetail = $oJResp.StringOf("meta.warnings[i].detail")
$sTitle = $oJResp.StringOf("meta.warnings[i].title")
$i = $i + 1
Wend
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"compute": [
{
"aggregation": "cardinality",
"interval": "<string>",
"metric": "<string>",
"type": "total"
},
{
"aggregation": "cardinality",
"interval": "<string>",
"metric": "<string>",
"type": "total"
}
],
"filter": {
"from": "now-15m",
"indexes": [
"*"
],
"query": "*",
"storage_tier": "indexes",
"to": "now"
},
"group_by": [
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "median",
"metric": "<string>",
"order": "asc",
"type": "alphabetical"
},
"total": "<boolean>"
},
{
"facet": "<string>",
"histogram": {
"interval": "<double>",
"min": "<double>",
"max": "<double>"
},
"limit": 10,
"missing": "<string>",
"sort": {
"aggregation": "cardinality",
"metric": "<string>",
"order": "asc",
"type": "alphabetical"
},
"total": "<boolean>"
}
],
"options": {
"timeOffset": "<long>",
"timezone": "UTC"
},
"page": {
"cursor": "<string>"
}
}'
https://api.app.ddog-gov.com/api/v2/logs/analytics/aggregate
Postman Collection Item JSON
{
"name": "Aggregate 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\": \"cardinality\",\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 \"indexes\": [\n \"*\"\n ],\n \"query\": \"*\",\n \"storage_tier\": \"indexes\",\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\": \"median\",\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\": \"cardinality\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"analytics",
"aggregate"
]
},
"description": "The API endpoint to aggregate events into buckets and compute 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\": \"cardinality\",\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 \"indexes\": [\n \"*\"\n ],\n \"query\": \"*\",\n \"storage_tier\": \"indexes\",\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\": \"median\",\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\": \"cardinality\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"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 \"in__11\": {\n \"description\": \"The values for each group by\"\n },\n \"magna_c7\": {\n \"description\": \"The values for each group by\"\n }\n },\n \"computes\": {\n \"id_3\": \"<string>\"\n }\n },\n {\n \"by\": {\n \"cillum_d9\": {\n \"description\": \"The values for each group by\"\n },\n \"est_ec\": {\n \"description\": \"The values for each group by\"\n },\n \"in_5a4\": {\n \"description\": \"The values for each group by\"\n }\n },\n \"computes\": {\n \"ex_b\": \"<string>\"\n }\n }\n ]\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\": \"cardinality\",\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 \"indexes\": [\n \"*\"\n ],\n \"query\": \"*\",\n \"storage_tier\": \"indexes\",\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\": \"median\",\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\": \"cardinality\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"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\": \"cardinality\",\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 \"indexes\": [\n \"*\"\n ],\n \"query\": \"*\",\n \"storage_tier\": \"indexes\",\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\": \"median\",\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\": \"cardinality\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"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\": \"cardinality\",\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 \"indexes\": [\n \"*\"\n ],\n \"query\": \"*\",\n \"storage_tier\": \"indexes\",\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\": \"median\",\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\": \"cardinality\",\n \"metric\": \"<string>\",\n \"order\": \"asc\",\n \"type\": \"alphabetical\"\n },\n \"total\": \"<boolean>\"\n }\n ],\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/analytics/aggregate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"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}"
}
]
}
