Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
' 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>"
' }
' }
Dim json As New ChilkatJsonObject
success = json.UpdateString("compute[0].aggregation","cardinality")
success = json.UpdateString("compute[0].interval","<string>")
success = json.UpdateString("compute[0].metric","<string>")
success = json.UpdateString("compute[0].type","total")
success = json.UpdateString("compute[1].aggregation","cardinality")
success = json.UpdateString("compute[1].interval","<string>")
success = json.UpdateString("compute[1].metric","<string>")
success = json.UpdateString("compute[1].type","total")
success = json.UpdateString("filter.from","now-15m")
success = json.UpdateString("filter.indexes[0]","*")
success = json.UpdateString("filter.query","*")
success = json.UpdateString("filter.storage_tier","indexes")
success = json.UpdateString("filter.to","now")
success = json.UpdateString("group_by[0].facet","<string>")
success = json.UpdateString("group_by[0].histogram.interval","<double>")
success = json.UpdateString("group_by[0].histogram.min","<double>")
success = json.UpdateString("group_by[0].histogram.max","<double>")
success = json.UpdateInt("group_by[0].limit",10)
success = json.UpdateString("group_by[0].missing","<string>")
success = json.UpdateString("group_by[0].sort.aggregation","median")
success = json.UpdateString("group_by[0].sort.metric","<string>")
success = json.UpdateString("group_by[0].sort.order","asc")
success = json.UpdateString("group_by[0].sort.type","alphabetical")
success = json.UpdateString("group_by[0].total","<boolean>")
success = json.UpdateString("group_by[1].facet","<string>")
success = json.UpdateString("group_by[1].histogram.interval","<double>")
success = json.UpdateString("group_by[1].histogram.min","<double>")
success = json.UpdateString("group_by[1].histogram.max","<double>")
success = json.UpdateInt("group_by[1].limit",10)
success = json.UpdateString("group_by[1].missing","<string>")
success = json.UpdateString("group_by[1].sort.aggregation","cardinality")
success = json.UpdateString("group_by[1].sort.metric","<string>")
success = json.UpdateString("group_by[1].sort.order","asc")
success = json.UpdateString("group_by[1].sort.type","alphabetical")
success = json.UpdateString("group_by[1].total","<boolean>")
success = json.UpdateString("options.timeOffset","<long>")
success = json.UpdateString("options.timezone","UTC")
success = json.UpdateString("page.cursor","<string>")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/logs/analytics/aggregate","application/json",json)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim Description As String
Dim Magna_c7Description As String
Dim Id_3 As String
Dim Cillum_d9Description As String
Dim Est_ecDescription As String
Dim In_5a4Description As String
Dim Ex_b As String
Dim code As String
Dim detail As String
Dim title As String
Dim Elapsed As String
Elapsed = jResp.StringOf("meta.elapsed")
Dim After As String
After = jResp.StringOf("meta.page.after")
Dim Request_id As String
Request_id = jResp.StringOf("meta.request_id")
Dim Status As String
Status = jResp.StringOf("meta.status")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data.buckets")
Do 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
Loop
i = 0
count_i = jResp.SizeOfArray("meta.warnings")
Do 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
Loop
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}"
}
]
}
