Chilkat Online Tools

unicodeCpp / Datadog API Collection / Search spans

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool success;

    // 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"
    //   }
    // }

    CkJsonObjectW json;
    json.UpdateString(L"data.attributes.filter.from",L"now-15m");
    json.UpdateString(L"data.attributes.filter.query",L"*");
    json.UpdateString(L"data.attributes.filter.to",L"now");
    json.UpdateString(L"data.attributes.options.timeOffset",L"<long>");
    json.UpdateString(L"data.attributes.options.timezone",L"UTC");
    json.UpdateString(L"data.attributes.page.cursor",L"<string>");
    json.UpdateInt(L"data.attributes.page.limit",10);
    json.UpdateString(L"data.attributes.sort",L"-timestamp");
    json.UpdateString(L"data.type",L"search_request");

    http.SetRequestHeader(L"Content-Type",L"application/json");
    http.SetRequestHeader(L"Accept",L"application/json");

    CkHttpResponseW *resp = http.PostJson3(L"https://api.app.ddog-gov.com/api/v2/spans/events/search",L"application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *End_timestamp = 0;
    const wchar_t *Env = 0;
    const wchar_t *Host = 0;
    const wchar_t *Ingestion_reason = 0;
    const wchar_t *Parent_id = 0;
    const wchar_t *Resource_hash = 0;
    const wchar_t *Resource_name = 0;
    const wchar_t *Retained_by = 0;
    const wchar_t *Service = 0;
    const wchar_t *Single_span = 0;
    const wchar_t *Span_id = 0;
    const wchar_t *Start_timestamp = 0;
    const wchar_t *Trace_id = 0;
    const wchar_t *v_Type = 0;
    const wchar_t *id = 0;
    const wchar_t *v_type = 0;
    int j;
    int count_j;
    const wchar_t *strVal = 0;
    const wchar_t *code = 0;
    const wchar_t *detail = 0;
    const wchar_t *title = 0;

    const wchar_t *v_Next = jResp.stringOf(L"links.next");
    const wchar_t *Elapsed = jResp.stringOf(L"meta.elapsed");
    const wchar_t *After = jResp.stringOf(L"meta.page.after");
    const wchar_t *Request_id = jResp.stringOf(L"meta.request_id");
    const wchar_t *Status = jResp.stringOf(L"meta.status");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"data");
    while (i < count_i) {
        jResp.put_I(i);
        End_timestamp = jResp.stringOf(L"data[i].attributes.end_timestamp");
        Env = jResp.stringOf(L"data[i].attributes.env");
        Host = jResp.stringOf(L"data[i].attributes.host");
        Ingestion_reason = jResp.stringOf(L"data[i].attributes.ingestion_reason");
        Parent_id = jResp.stringOf(L"data[i].attributes.parent_id");
        Resource_hash = jResp.stringOf(L"data[i].attributes.resource_hash");
        Resource_name = jResp.stringOf(L"data[i].attributes.resource_name");
        Retained_by = jResp.stringOf(L"data[i].attributes.retained_by");
        Service = jResp.stringOf(L"data[i].attributes.service");
        Single_span = jResp.stringOf(L"data[i].attributes.single_span");
        Span_id = jResp.stringOf(L"data[i].attributes.span_id");
        Start_timestamp = jResp.stringOf(L"data[i].attributes.start_timestamp");
        Trace_id = jResp.stringOf(L"data[i].attributes.trace_id");
        v_Type = jResp.stringOf(L"data[i].attributes.type");
        id = jResp.stringOf(L"data[i].id");
        v_type = jResp.stringOf(L"data[i].type");
        j = 0;
        count_j = jResp.SizeOfArray(L"data[i].attributes.tags");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"data[i].attributes.tags[j]");
            j = j + 1;
        }

        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"meta.warnings");
    while (i < count_i) {
        jResp.put_I(i);
        code = jResp.stringOf(L"meta.warnings[i].code");
        detail = jResp.stringOf(L"meta.warnings[i].detail");
        title = jResp.stringOf(L"meta.warnings[i].title");
        i = i + 1;
    }
    }

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}"
    }
  ]
}