phpAx / Datadog API Collection / Query scalar data across multiple products
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.
// {
// "data": {
// "type": "scalar_request",
// "attributes": {
// "to": "<long>",
// "from": "<long>",
// "queries": [
// {
// "data_source": "metrics",
// "query": "<string>",
// "aggregator": "avg",
// "name": "<string>"
// },
// {
// "data_source": "metrics",
// "query": "<string>",
// "aggregator": "avg",
// "name": "<string>"
// }
// ],
// "formulas": [
// {
// "formula": "<string>",
// "limit": {
// "count": "<integer>",
// "order": "desc"
// }
// },
// {
// "formula": "<string>",
// "limit": {
// "count": "<integer>",
// "order": "desc"
// }
// }
// ]
// }
// }
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('data.type','scalar_request');
$json->UpdateString('data.attributes.to','<long>');
$json->UpdateString('data.attributes.from','<long>');
$json->UpdateString('data.attributes.queries[0].data_source','metrics');
$json->UpdateString('data.attributes.queries[0].query','<string>');
$json->UpdateString('data.attributes.queries[0].aggregator','avg');
$json->UpdateString('data.attributes.queries[0].name','<string>');
$json->UpdateString('data.attributes.queries[1].data_source','metrics');
$json->UpdateString('data.attributes.queries[1].query','<string>');
$json->UpdateString('data.attributes.queries[1].aggregator','avg');
$json->UpdateString('data.attributes.queries[1].name','<string>');
$json->UpdateString('data.attributes.formulas[0].formula','<string>');
$json->UpdateString('data.attributes.formulas[0].limit.count','<integer>');
$json->UpdateString('data.attributes.formulas[0].limit.order','desc');
$json->UpdateString('data.attributes.formulas[1].formula','<string>');
$json->UpdateString('data.attributes.formulas[1].limit.count','<integer>');
$json->UpdateString('data.attributes.formulas[1].limit.order','desc');
$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/query/scalar','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": {
// "attributes": {
// "columns": [
// {
// "name": "<string>",
// "type": "<string>",
// "values": [
// [
// "<string>",
// "<string>"
// ],
// [
// "<string>",
// "<string>"
// ]
// ]
// },
// {
// "name": "<string>",
// "type": "<string>",
// "values": [
// [
// "<string>",
// "<string>"
// ],
// [
// "<string>",
// "<string>"
// ]
// ]
// }
// ]
// },
// "type": "scalar_response"
// },
// "errors": "<string>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$v_Type = $jResp->stringOf('data.type');
$errors = $jResp->stringOf('errors');
$i = 0;
$count_i = $jResp->SizeOfArray('data.attributes.columns');
while ($i < $count_i) {
$jResp->I = $i;
$name = $jResp->stringOf('data.attributes.columns[i].name');
$v_type = $jResp->stringOf('data.attributes.columns[i].type');
$j = 0;
$count_j = $jResp->SizeOfArray('data.attributes.columns[i].values');
while ($j < $count_j) {
$jResp->J = $j;
$k = 0;
$count_k = $jResp->SizeOfArray('data.attributes.columns[i].values[j]');
while ($k < $count_k) {
$jResp->K = $k;
$strVal = $jResp->stringOf('data.attributes.columns[i].values[j][k]');
$k = $k + 1;
}
$j = $j + 1;
}
$i = $i + 1;
}
?>
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "scalar_request",
"attributes": {
"to": "<long>",
"from": "<long>",
"queries": [
{
"data_source": "metrics",
"query": "<string>",
"aggregator": "avg",
"name": "<string>"
},
{
"data_source": "metrics",
"query": "<string>",
"aggregator": "avg",
"name": "<string>"
}
],
"formulas": [
{
"formula": "<string>",
"limit": {
"count": "<integer>",
"order": "desc"
}
},
{
"formula": "<string>",
"limit": {
"count": "<integer>",
"order": "desc"
}
}
]
}
}
}'
https://api.app.ddog-gov.com/api/v2/query/scalar
Postman Collection Item JSON
{
"name": "Query scalar data across multiple products",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
},
"description": "Query scalar values (as seen on Query Value, Table, and Toplist widgets).\nMultiple data sources are supported with the ability to\nprocess the data using formulas and functions."
},
"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 \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"values\": [\n [\n \"<string>\",\n \"<string>\"\n ],\n [\n \"<string>\",\n \"<string>\"\n ]\n ]\n },\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"values\": [\n [\n \"<string>\",\n \"<string>\"\n ],\n [\n \"<string>\",\n \"<string>\"\n ]\n ]\n }\n ]\n },\n \"type\": \"scalar_response\"\n },\n \"errors\": \"<string>\"\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 \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"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": "Unauthorized",
"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 \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"status": "Unauthorized",
"code": 401,
"_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 \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"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 \"type\": \"scalar_request\",\n \"attributes\": {\n \"to\": \"<long>\",\n \"from\": \"<long>\",\n \"queries\": [\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n },\n {\n \"data_source\": \"metrics\",\n \"query\": \"<string>\",\n \"aggregator\": \"avg\",\n \"name\": \"<string>\"\n }\n ],\n \"formulas\": [\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n },\n {\n \"formula\": \"<string>\",\n \"limit\": {\n \"count\": \"<integer>\",\n \"order\": \"desc\"\n }\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/query/scalar",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"query",
"scalar"
]
}
},
"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}"
}
]
}
