Chilkat Online Tools

unicodeC / Datadog API Collection / Get a list of logs

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *Host;
    const wchar_t *Message;
    const wchar_t *Service;
    const wchar_t *attributesStatus;
    const wchar_t *Timestamp;
    const wchar_t *id;
    const wchar_t *v_type;
    int j;
    int count_j;
    const wchar_t *strVal;
    const wchar_t *code;
    const wchar_t *detail;
    const wchar_t *title;
    const wchar_t *v_Next;
    const wchar_t *Elapsed;
    const wchar_t *After;
    const wchar_t *Request_id;
    const wchar_t *Status;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"filter[query]",L"<string>");
    CkJsonObjectW_UpdateString(queryParams,L"filter[indexes]",L"<string>,<string>");
    CkJsonObjectW_UpdateString(queryParams,L"filter[from]",L"<dateTime>");
    CkJsonObjectW_UpdateString(queryParams,L"filter[to]",L"<dateTime>");
    CkJsonObjectW_UpdateString(queryParams,L"filter[storage_tier]",L"indexes");
    CkJsonObjectW_UpdateString(queryParams,L"sort",L"-timestamp");
    CkJsonObjectW_UpdateString(queryParams,L"page[cursor]",L"<string>");
    CkJsonObjectW_UpdateInt(queryParams,L"page[limit]",10);

    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.app.ddog-gov.com/api/v2/logs/events",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

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

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": [
    //     {
    //       "attributes": {
    //         "attributes": {
    //           "consectetur__9": {},
    //           "aliquip_43": {}
    //         },
    //         "host": "<string>",
    //         "message": "<string>",
    //         "service": "<string>",
    //         "status": "<string>",
    //         "tags": [
    //           "<string>",
    //           "<string>"
    //         ],
    //         "timestamp": "<dateTime>"
    //       },
    //       "id": "<string>",
    //       "type": "log"
    //     },
    //     {
    //       "attributes": {
    //         "attributes": {
    //           "nisia4a": {},
    //           "dolor4": {}
    //         },
    //         "host": "<string>",
    //         "message": "<string>",
    //         "service": "<string>",
    //         "status": "<string>",
    //         "tags": [
    //           "<string>",
    //           "<string>"
    //         ],
    //         "timestamp": "<dateTime>"
    //       },
    //       "id": "<string>",
    //       "type": "log"
    //     }
    //   ],
    //   "links": {
    //     "next": "<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

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

    v_Next = CkJsonObjectW_stringOf(jResp,L"links.next");
    Elapsed = CkJsonObjectW_stringOf(jResp,L"meta.elapsed");
    After = CkJsonObjectW_stringOf(jResp,L"meta.page.after");
    Request_id = CkJsonObjectW_stringOf(jResp,L"meta.request_id");
    Status = CkJsonObjectW_stringOf(jResp,L"meta.status");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"data");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        Host = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.host");
        Message = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.message");
        Service = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.service");
        attributesStatus = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.status");
        Timestamp = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.timestamp");
        id = CkJsonObjectW_stringOf(jResp,L"data[i].id");
        v_type = CkJsonObjectW_stringOf(jResp,L"data[i].type");
        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"data[i].attributes.tags");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            strVal = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.tags[j]");
            j = j + 1;
        }

        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"meta.warnings");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        code = CkJsonObjectW_stringOf(jResp,L"meta.warnings[i].code");
        detail = CkJsonObjectW_stringOf(jResp,L"meta.warnings[i].detail");
        title = CkJsonObjectW_stringOf(jResp,L"meta.warnings[i].title");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -G -d "filter[query]=%3Cstring%3E"
	-d "filter[indexes]=%3Cstring%3E,%3Cstring%3E"
	-d "filter[from]=%3CdateTime%3E"
	-d "filter[to]=%3CdateTime%3E"
	-d "filter[storage_tier]=indexes"
	-d "sort=-timestamp"
	-d "page[cursor]=%3Cstring%3E"
	-d "page[limit]=10"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/logs/events

Postman Collection Item JSON

{
  "name": "Get a list of logs",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "events"
      ],
      "query": [
        {
          "key": "filter[query]",
          "value": "<string>",
          "description": "Search query following logs syntax."
        },
        {
          "key": "filter[indexes]",
          "value": "<string>,<string>",
          "description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
        },
        {
          "key": "filter[from]",
          "value": "<dateTime>",
          "description": "Minimum timestamp for requested logs."
        },
        {
          "key": "filter[to]",
          "value": "<dateTime>",
          "description": "Maximum timestamp for requested logs."
        },
        {
          "key": "filter[storage_tier]",
          "value": "indexes",
          "description": "Specifies the storage type to be used"
        },
        {
          "key": "sort",
          "value": "-timestamp",
          "description": "Order of logs 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 logs in the response."
        }
      ]
    },
    "description": "List endpoint returns logs that match a log search query.\n[Results are paginated][1].\n\nUse this endpoint to see your latest logs.\n\n**If you are considering archiving logs for your organization,\nconsider use of the Datadog archive capabilities instead of the log list API.\nSee [Datadog Logs Archive documentation][2].**\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination\n[2]: https://docs.datadoghq.com/logs/archives"
  },
  "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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following logs syntax."
            },
            {
              "key": "filter[indexes]",
              "value": "<string>,<string>",
              "description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "Minimum timestamp for requested logs."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "Maximum timestamp for requested logs."
            },
            {
              "key": "filter[storage_tier]",
              "value": "indexes",
              "description": "Specifies the storage type to be used"
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "Order of logs 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 logs 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          \"consectetur__9\": {},\n          \"aliquip_43\": {}\n        },\n        \"host\": \"<string>\",\n        \"message\": \"<string>\",\n        \"service\": \"<string>\",\n        \"status\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"log\"\n    },\n    {\n      \"attributes\": {\n        \"attributes\": {\n          \"nisia4a\": {},\n          \"dolor4\": {}\n        },\n        \"host\": \"<string>\",\n        \"message\": \"<string>\",\n        \"service\": \"<string>\",\n        \"status\": \"<string>\",\n        \"tags\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"timestamp\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"log\"\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\": \"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": "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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following logs syntax."
            },
            {
              "key": "filter[indexes]",
              "value": "<string>,<string>",
              "description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "Minimum timestamp for requested logs."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "Maximum timestamp for requested logs."
            },
            {
              "key": "filter[storage_tier]",
              "value": "indexes",
              "description": "Specifies the storage type to be used"
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "Order of logs 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 logs in the response."
            }
          ]
        }
      },
      "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": "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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following logs syntax."
            },
            {
              "key": "filter[indexes]",
              "value": "<string>,<string>",
              "description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "Minimum timestamp for requested logs."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "Maximum timestamp for requested logs."
            },
            {
              "key": "filter[storage_tier]",
              "value": "indexes",
              "description": "Specifies the storage type to be used"
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "Order of logs 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 logs in the response."
            }
          ]
        }
      },
      "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": "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/logs/events?filter[query]=<string>&filter[indexes]=<string>,<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&filter[storage_tier]=indexes&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events"
          ],
          "query": [
            {
              "key": "filter[query]",
              "value": "<string>",
              "description": "Search query following logs syntax."
            },
            {
              "key": "filter[indexes]",
              "value": "<string>,<string>",
              "description": "For customers with multiple indexes, the indexes to search.\nDefaults to '*' which means all indexes"
            },
            {
              "key": "filter[from]",
              "value": "<dateTime>",
              "description": "Minimum timestamp for requested logs."
            },
            {
              "key": "filter[to]",
              "value": "<dateTime>",
              "description": "Maximum timestamp for requested logs."
            },
            {
              "key": "filter[storage_tier]",
              "value": "indexes",
              "description": "Specifies the storage type to be used"
            },
            {
              "key": "sort",
              "value": "-timestamp",
              "description": "Order of logs 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 logs in the response."
            }
          ]
        }
      },
      "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}"
    }
  ]
}