Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// 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>"
// }
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('compute[0].aggregation','cardinality');
$json->UpdateString('compute[0].interval','<string>');
$json->UpdateString('compute[0].metric','<string>');
$json->UpdateString('compute[0].type','total');
$json->UpdateString('compute[1].aggregation','cardinality');
$json->UpdateString('compute[1].interval','<string>');
$json->UpdateString('compute[1].metric','<string>');
$json->UpdateString('compute[1].type','total');
$json->UpdateString('filter.from','now-15m');
$json->UpdateString('filter.indexes[0]','*');
$json->UpdateString('filter.query','*');
$json->UpdateString('filter.storage_tier','indexes');
$json->UpdateString('filter.to','now');
$json->UpdateString('group_by[0].facet','<string>');
$json->UpdateString('group_by[0].histogram.interval','<double>');
$json->UpdateString('group_by[0].histogram.min','<double>');
$json->UpdateString('group_by[0].histogram.max','<double>');
$json->UpdateInt('group_by[0].limit',10);
$json->UpdateString('group_by[0].missing','<string>');
$json->UpdateString('group_by[0].sort.aggregation','median');
$json->UpdateString('group_by[0].sort.metric','<string>');
$json->UpdateString('group_by[0].sort.order','asc');
$json->UpdateString('group_by[0].sort.type','alphabetical');
$json->UpdateString('group_by[0].total','<boolean>');
$json->UpdateString('group_by[1].facet','<string>');
$json->UpdateString('group_by[1].histogram.interval','<double>');
$json->UpdateString('group_by[1].histogram.min','<double>');
$json->UpdateString('group_by[1].histogram.max','<double>');
$json->UpdateInt('group_by[1].limit',10);
$json->UpdateString('group_by[1].missing','<string>');
$json->UpdateString('group_by[1].sort.aggregation','cardinality');
$json->UpdateString('group_by[1].sort.metric','<string>');
$json->UpdateString('group_by[1].sort.order','asc');
$json->UpdateString('group_by[1].sort.type','alphabetical');
$json->UpdateString('group_by[1].total','<boolean>');
$json->UpdateString('options.timeOffset','<long>');
$json->UpdateString('options.timezone','UTC');
$json->UpdateString('page.cursor','<string>');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api.app.ddog-gov.com/api/v2/logs/analytics/aggregate','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$Elapsed = $jResp->stringOf('meta.elapsed');
$After = $jResp->stringOf('meta.page.after');
$Request_id = $jResp->stringOf('meta.request_id');
$Status = $jResp->stringOf('meta.status');
$i = 0;
$count_i = $jResp->SizeOfArray('data.buckets');
while ($i < $count_i) {
$jResp->I = $i;
$Description = $jResp->stringOf('data.buckets[i].by.in__11.description');
$Magna_c7Description = $jResp->stringOf('data.buckets[i].by.magna_c7.description');
$Id_3 = $jResp->stringOf('data.buckets[i].computes.id_3');
$Cillum_d9Description = $jResp->stringOf('data.buckets[i].by.cillum_d9.description');
$Est_ecDescription = $jResp->stringOf('data.buckets[i].by.est_ec.description');
$In_5a4Description = $jResp->stringOf('data.buckets[i].by.in_5a4.description');
$Ex_b = $jResp->stringOf('data.buckets[i].computes.ex_b');
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray('meta.warnings');
while ($i < $count_i) {
$jResp->I = $i;
$code = $jResp->stringOf('meta.warnings[i].code');
$detail = $jResp->stringOf('meta.warnings[i].detail');
$title = $jResp->stringOf('meta.warnings[i].title');
$i = $i + 1;
}
?>
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}"
}
]
}
