Foxpro / Datadog API Collection / Query scalar data across multiple products
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcV_type
LOCAL j
LOCAL lnCount_j
LOCAL k
LOCAL lnCount_k
LOCAL lcStrVal
LOCAL lcV_Type
LOCAL lcErrors
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.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"
* }
* }
* ]
* }
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("data.type","scalar_request")
loJson.UpdateString("data.attributes.to","<long>")
loJson.UpdateString("data.attributes.from","<long>")
loJson.UpdateString("data.attributes.queries[0].data_source","metrics")
loJson.UpdateString("data.attributes.queries[0].query","<string>")
loJson.UpdateString("data.attributes.queries[0].aggregator","avg")
loJson.UpdateString("data.attributes.queries[0].name","<string>")
loJson.UpdateString("data.attributes.queries[1].data_source","metrics")
loJson.UpdateString("data.attributes.queries[1].query","<string>")
loJson.UpdateString("data.attributes.queries[1].aggregator","avg")
loJson.UpdateString("data.attributes.queries[1].name","<string>")
loJson.UpdateString("data.attributes.formulas[0].formula","<string>")
loJson.UpdateString("data.attributes.formulas[0].limit.count","<integer>")
loJson.UpdateString("data.attributes.formulas[0].limit.order","desc")
loJson.UpdateString("data.attributes.formulas[1].formula","<string>")
loJson.UpdateString("data.attributes.formulas[1].limit.count","<integer>")
loJson.UpdateString("data.attributes.formulas[1].limit.order","desc")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v2/query/scalar","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
ENDIF
RELEASE loResp
* 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
lcV_Type = loJResp.StringOf("data.type")
lcErrors = loJResp.StringOf("errors")
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.columns")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("data.attributes.columns[i].name")
lcV_type = loJResp.StringOf("data.attributes.columns[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("data.attributes.columns[i].values")
DO WHILE j < lnCount_j
loJResp.J = j
k = 0
lnCount_k = loJResp.SizeOfArray("data.attributes.columns[i].values[j]")
DO WHILE k < lnCount_k
loJResp.K = k
lcStrVal = loJResp.StringOf("data.attributes.columns[i].values[j][k]")
k = k + 1
ENDDO
j = j + 1
ENDDO
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": {
"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}"
}
]
}