Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("filter[query]","<string>");
queryParams.UpdateString("filter[from]","<string>");
queryParams.UpdateString("filter[to]","<string>");
queryParams.UpdateString("sort","timestamp");
queryParams.UpdateString("page[cursor]","<string>");
queryParams.UpdateInt("page[limit]",10);
http.SetRequestHeader("Accept","application/json");
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/spans/events",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// 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
var End_timestamp;
var Env;
var Host;
var Ingestion_reason;
var Parent_id;
var Resource_hash;
var Resource_name;
var Retained_by;
var Service;
var Single_span;
var Span_id;
var Start_timestamp;
var Trace_id;
var v_Type;
var id;
var v_type;
var j;
var count_j;
var strVal;
var code;
var detail;
var title;
var v_Next = jResp.StringOf("links.next");
var Elapsed = jResp.StringOf("meta.elapsed");
var After = jResp.StringOf("meta.page.after");
var Request_id = jResp.StringOf("meta.request_id");
var Status = jResp.StringOf("meta.status");
var i = 0;
var count_i = jResp.SizeOfArray("data");
while (i < count_i) {
jResp.I = i;
End_timestamp = jResp.StringOf("data[i].attributes.end_timestamp");
Env = jResp.StringOf("data[i].attributes.env");
Host = jResp.StringOf("data[i].attributes.host");
Ingestion_reason = jResp.StringOf("data[i].attributes.ingestion_reason");
Parent_id = jResp.StringOf("data[i].attributes.parent_id");
Resource_hash = jResp.StringOf("data[i].attributes.resource_hash");
Resource_name = jResp.StringOf("data[i].attributes.resource_name");
Retained_by = jResp.StringOf("data[i].attributes.retained_by");
Service = jResp.StringOf("data[i].attributes.service");
Single_span = jResp.StringOf("data[i].attributes.single_span");
Span_id = jResp.StringOf("data[i].attributes.span_id");
Start_timestamp = jResp.StringOf("data[i].attributes.start_timestamp");
Trace_id = jResp.StringOf("data[i].attributes.trace_id");
v_Type = jResp.StringOf("data[i].attributes.type");
id = jResp.StringOf("data[i].id");
v_type = jResp.StringOf("data[i].type");
j = 0;
count_j = jResp.SizeOfArray("data[i].attributes.tags");
while (j < count_j) {
jResp.J = j;
strVal = jResp.StringOf("data[i].attributes.tags[j]");
j = j+1;
}
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("meta.warnings");
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;
}
}
chilkatExample();
Curl Command
curl -G -d "filter[query]=%3Cstring%3E"
-d "filter[from]=%3Cstring%3E"
-d "filter[to]=%3Cstring%3E"
-d "sort=timestamp"
-d "page[cursor]=%3Cstring%3E"
-d "page[limit]=10"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/spans/events
Postman Collection Item JSON
{
"name": "Get a list of spans",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following spans syntax."
},
{
"key": "filter[from]",
"value": "<string>",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "filter[to]",
"value": "<string>",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of spans in the response."
}
]
},
"description": "List endpoint returns spans that match a span search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest spans.\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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following spans syntax."
},
{
"key": "filter[from]",
"value": "<string>",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "filter[to]",
"value": "<string>",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of spans in the response."
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following spans syntax."
},
{
"key": "filter[from]",
"value": "<string>",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "filter[to]",
"value": "<string>",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of spans in the response."
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following spans syntax."
},
{
"key": "filter[from]",
"value": "<string>",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "filter[to]",
"value": "<string>",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of spans in the response."
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following spans syntax."
},
{
"key": "filter[from]",
"value": "<string>",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "filter[to]",
"value": "<string>",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of spans in the response."
}
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/spans/events?filter[query]=<string>&filter[from]=<string>&filter[to]=<string>&sort=timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"spans",
"events"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "Search query following spans syntax."
},
{
"key": "filter[from]",
"value": "<string>",
"description": "Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "filter[to]",
"value": "<string>",
"description": "Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds)."
},
{
"key": "sort",
"value": "timestamp",
"description": "Order of spans in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "List following results with a cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "Maximum number of spans in the response."
}
]
}
},
"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}"
}
]
}
