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.
; {
; "data": {
; "attributes": {
; "filter": {
; "from": "now-15m",
; "query": "*",
; "to": "now"
; },
; "options": {
; "timeOffset": "<long>",
; "timezone": "UTC"
; },
; "page": {
; "cursor": "<string>",
; "limit": 10
; },
; "sort": "-timestamp"
; },
; "type": "search_request"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("data.attributes.filter.from","now-15m")
$oJson.UpdateString("data.attributes.filter.query","*")
$oJson.UpdateString("data.attributes.filter.to","now")
$oJson.UpdateString("data.attributes.options.timeOffset","<long>")
$oJson.UpdateString("data.attributes.options.timezone","UTC")
$oJson.UpdateString("data.attributes.page.cursor","<string>")
$oJson.UpdateInt("data.attributes.page.limit",10)
$oJson.UpdateString("data.attributes.sort","-timestamp")
$oJson.UpdateString("data.type","search_request")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.PostJson3("https://api.app.ddog-gov.com/api/v2/spans/events/search","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": [
; {
; "attributes": {
; "attributes": {
; "culpac": {}
; },
; "custom": {
; "aliquip_8": {},
; "commodo_9c1": {}
; },
; "end_timestamp": "<dateTime>",
; "env": "<string>",
; "host": "<string>",
; "ingestion_reason": "<string>",
; "parent_id": "<string>",
; "resource_hash": "<string>",
; "resource_name": "<string>",
; "retained_by": "<string>",
; "service": "<string>",
; "single_span": "<boolean>",
; "span_id": "<string>",
; "start_timestamp": "<dateTime>",
; "tags": [
; "<string>",
; "<string>"
; ],
; "trace_id": "<string>",
; "type": "<string>"
; },
; "id": "<string>",
; "type": "spans"
; },
; {
; "attributes": {
; "attributes": {
; "Lorem_c": {}
; },
; "custom": {
; "culpa_c": {},
; "consectetur_cf": {}
; },
; "end_timestamp": "<dateTime>",
; "env": "<string>",
; "host": "<string>",
; "ingestion_reason": "<string>",
; "parent_id": "<string>",
; "resource_hash": "<string>",
; "resource_name": "<string>",
; "retained_by": "<string>",
; "service": "<string>",
; "single_span": "<boolean>",
; "span_id": "<string>",
; "start_timestamp": "<dateTime>",
; "tags": [
; "<string>",
; "<string>"
; ],
; "trace_id": "<string>",
; "type": "<string>"
; },
; "id": "<string>",
; "type": "spans"
; }
; ],
; "links": {
; "next": "<string>"
; },
; "meta": {
; "elapsed": "<long>",
; "page": {
; "after": "<string>"
; },
; "request_id": "<string>",
; "status": "timeout",
; "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 $sEnd_timestamp
Local $sEnv
Local $sHost
Local $sIngestion_reason
Local $sParent_id
Local $sResource_hash
Local $sResource_name
Local $sRetained_by
Local $sService
Local $sSingle_span
Local $sSpan_id
Local $sStart_timestamp
Local $sTrace_id
Local $sV_Type
Local $sId
Local $sV_type
Local $iJ
Local $iCount_j
Local $strVal
Local $sCode
Local $sDetail
Local $sTitle
Local $sV_Next = $oJResp.StringOf("links.next")
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")
While $i < $iCount_i
$oJResp.I = $i
$sEnd_timestamp = $oJResp.StringOf("data[i].attributes.end_timestamp")
$sEnv = $oJResp.StringOf("data[i].attributes.env")
$sHost = $oJResp.StringOf("data[i].attributes.host")
$sIngestion_reason = $oJResp.StringOf("data[i].attributes.ingestion_reason")
$sParent_id = $oJResp.StringOf("data[i].attributes.parent_id")
$sResource_hash = $oJResp.StringOf("data[i].attributes.resource_hash")
$sResource_name = $oJResp.StringOf("data[i].attributes.resource_name")
$sRetained_by = $oJResp.StringOf("data[i].attributes.retained_by")
$sService = $oJResp.StringOf("data[i].attributes.service")
$sSingle_span = $oJResp.StringOf("data[i].attributes.single_span")
$sSpan_id = $oJResp.StringOf("data[i].attributes.span_id")
$sStart_timestamp = $oJResp.StringOf("data[i].attributes.start_timestamp")
$sTrace_id = $oJResp.StringOf("data[i].attributes.trace_id")
$sV_Type = $oJResp.StringOf("data[i].attributes.type")
$sId = $oJResp.StringOf("data[i].id")
$sV_type = $oJResp.StringOf("data[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attributes.tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].attributes.tags[j]")
$iJ = $iJ + 1
Wend
$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 '{
"data": {
"attributes": {
"filter": {
"from": "now-15m",
"query": "*",
"to": "now"
},
"options": {
"timeOffset": "<long>",
"timezone": "UTC"
},
"page": {
"cursor": "<string>",
"limit": 10
},
"sort": "-timestamp"
},
"type": "search_request"
}
}'
https://api.app.ddog-gov.com/api/v2/spans/events/search
Postman Collection Item JSON
{
"name": "Search spans",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n },\n \"sort\": \"-timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
},
"description": "List endpoint returns spans that match a span search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex spans filtering and search.\nThis endpoint is rate limited to `300` requests per hour.\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api"
},
"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 \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n },\n \"sort\": \"-timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"culpac\": {}\n },\n \"custom\": {\n \"aliquip_8\": {},\n \"commodo_9c1\": {}\n },\n \"end_timestamp\": \"<dateTime>\",\n \"env\": \"<string>\",\n \"host\": \"<string>\",\n \"ingestion_reason\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"resource_hash\": \"<string>\",\n \"resource_name\": \"<string>\",\n \"retained_by\": \"<string>\",\n \"service\": \"<string>\",\n \"single_span\": \"<boolean>\",\n \"span_id\": \"<string>\",\n \"start_timestamp\": \"<dateTime>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"trace_id\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"spans\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"Lorem_c\": {}\n },\n \"custom\": {\n \"culpa_c\": {},\n \"consectetur_cf\": {}\n },\n \"end_timestamp\": \"<dateTime>\",\n \"env\": \"<string>\",\n \"host\": \"<string>\",\n \"ingestion_reason\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"resource_hash\": \"<string>\",\n \"resource_name\": \"<string>\",\n \"retained_by\": \"<string>\",\n \"service\": \"<string>\",\n \"single_span\": \"<boolean>\",\n \"span_id\": \"<string>\",\n \"start_timestamp\": \"<dateTime>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"trace_id\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"type\": \"spans\"\n }\n ],\n \"links\": {\n \"next\": \"<string>\"\n },\n \"meta\": {\n \"elapsed\": \"<long>\",\n \"page\": {\n \"after\": \"<string>\"\n },\n \"request_id\": \"<string>\",\n \"status\": \"timeout\",\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 \"data\": {\n \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n },\n \"sort\": \"-timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n },\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Forbidden: Access denied.",
"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 \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n },\n \"sort\": \"-timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n },\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Unprocessable Entity.",
"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 \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n },\n \"sort\": \"-timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n },\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Too many requests: The rate limit set by the API has been exceeded.",
"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 \"attributes\": {\n \"filter\": {\n \"from\": \"now-15m\",\n \"query\": \"*\",\n \"to\": \"now\"\n },\n \"options\": {\n \"timeOffset\": \"<long>\",\n \"timezone\": \"UTC\"\n },\n \"page\": {\n \"cursor\": \"<string>\",\n \"limit\": 10\n },\n \"sort\": \"-timestamp\"\n },\n \"type\": \"search_request\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events",
"search"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n },\n {\n \"detail\": \"<string>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\"\n }\n ]\n}"
}
]
}
