Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "data.attributes.filter.from" "now-15m"
CkJsonObject_UpdateString $json "data.attributes.filter.query" "*"
CkJsonObject_UpdateString $json "data.attributes.filter.to" "now"
CkJsonObject_UpdateString $json "data.attributes.options.timeOffset" "<long>"
CkJsonObject_UpdateString $json "data.attributes.options.timezone" "UTC"
CkJsonObject_UpdateString $json "data.attributes.page.cursor" "<string>"
CkJsonObject_UpdateInt $json "data.attributes.page.limit" 10
CkJsonObject_UpdateString $json "data.attributes.sort" "-timestamp"
CkJsonObject_UpdateString $json "data.type" "search_request"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.app.ddog-gov.com/api/v2/spans/events/search" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set v_Next [CkJsonObject_stringOf $jResp "links.next"]
set Elapsed [CkJsonObject_stringOf $jResp "meta.elapsed"]
set After [CkJsonObject_stringOf $jResp "meta.page.after"]
set Request_id [CkJsonObject_stringOf $jResp "meta.request_id"]
set Status [CkJsonObject_stringOf $jResp "meta.status"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set End_timestamp [CkJsonObject_stringOf $jResp "data[i].attributes.end_timestamp"]
set Env [CkJsonObject_stringOf $jResp "data[i].attributes.env"]
set Host [CkJsonObject_stringOf $jResp "data[i].attributes.host"]
set Ingestion_reason [CkJsonObject_stringOf $jResp "data[i].attributes.ingestion_reason"]
set Parent_id [CkJsonObject_stringOf $jResp "data[i].attributes.parent_id"]
set Resource_hash [CkJsonObject_stringOf $jResp "data[i].attributes.resource_hash"]
set Resource_name [CkJsonObject_stringOf $jResp "data[i].attributes.resource_name"]
set Retained_by [CkJsonObject_stringOf $jResp "data[i].attributes.retained_by"]
set Service [CkJsonObject_stringOf $jResp "data[i].attributes.service"]
set Single_span [CkJsonObject_stringOf $jResp "data[i].attributes.single_span"]
set Span_id [CkJsonObject_stringOf $jResp "data[i].attributes.span_id"]
set Start_timestamp [CkJsonObject_stringOf $jResp "data[i].attributes.start_timestamp"]
set Trace_id [CkJsonObject_stringOf $jResp "data[i].attributes.trace_id"]
set v_Type [CkJsonObject_stringOf $jResp "data[i].attributes.type"]
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].attributes.tags"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "data[i].attributes.tags[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "meta.warnings"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set code [CkJsonObject_stringOf $jResp "meta.warnings[i].code"]
set detail [CkJsonObject_stringOf $jResp "meta.warnings[i].detail"]
set title [CkJsonObject_stringOf $jResp "meta.warnings[i].title"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}