Chilkat Online Tools

PureBasic / Datadog API Collection / Search logs

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "filter": {
    ;     "from": "now-15m",
    ;     "indexes": [
    ;       "*"
    ;     ],
    ;     "query": "*",
    ;     "storage_tier": "indexes",
    ;     "to": "now"
    ;   },
    ;   "options": {
    ;     "timeOffset": "<long>",
    ;     "timezone": "UTC"
    ;   },
    ;   "page": {
    ;     "cursor": "<string>",
    ;     "limit": 10
    ;   },
    ;   "sort": "timestamp"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"filter.from","now-15m")
    CkJsonObject::ckUpdateString(json,"filter.indexes[0]","*")
    CkJsonObject::ckUpdateString(json,"filter.query","*")
    CkJsonObject::ckUpdateString(json,"filter.storage_tier","indexes")
    CkJsonObject::ckUpdateString(json,"filter.to","now")
    CkJsonObject::ckUpdateString(json,"options.timeOffset","<long>")
    CkJsonObject::ckUpdateString(json,"options.timezone","UTC")
    CkJsonObject::ckUpdateString(json,"page.cursor","<string>")
    CkJsonObject::ckUpdateInt(json,"page.limit",10)
    CkJsonObject::ckUpdateString(json,"sort","timestamp")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.app.ddog-gov.com/api/v2/logs/events/search","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    Host.s
    Message.s
    Service.s
    attributesStatus.s
    Timestamp.s
    id.s
    v_type.s
    j.i
    count_j.i
    strVal.s
    code.s
    detail.s
    title.s

    v_Next.s = CkJsonObject::ckStringOf(jResp,"links.next")
    Elapsed.s = CkJsonObject::ckStringOf(jResp,"meta.elapsed")
    After.s = CkJsonObject::ckStringOf(jResp,"meta.page.after")
    Request_id.s = CkJsonObject::ckStringOf(jResp,"meta.request_id")
    Status.s = CkJsonObject::ckStringOf(jResp,"meta.status")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Host = CkJsonObject::ckStringOf(jResp,"data[i].attributes.host")
        Message = CkJsonObject::ckStringOf(jResp,"data[i].attributes.message")
        Service = CkJsonObject::ckStringOf(jResp,"data[i].attributes.service")
        attributesStatus = CkJsonObject::ckStringOf(jResp,"data[i].attributes.status")
        Timestamp = CkJsonObject::ckStringOf(jResp,"data[i].attributes.timestamp")
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attributes.tags")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"data[i].attributes.tags[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"meta.warnings")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        code = CkJsonObject::ckStringOf(jResp,"meta.warnings[i].code")
        detail = CkJsonObject::ckStringOf(jResp,"meta.warnings[i].detail")
        title = CkJsonObject::ckStringOf(jResp,"meta.warnings[i].title")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "filter": {
    "from": "now-15m",
    "indexes": [
      "*"
    ],
    "query": "*",
    "storage_tier": "indexes",
    "to": "now"
  },
  "options": {
    "timeOffset": "<long>",
    "timezone": "UTC"
  },
  "page": {
    "cursor": "<string>",
    "limit": 10
  },
  "sort": "timestamp"
}'
https://api.app.ddog-gov.com/api/v2/logs/events/search

Postman Collection Item JSON

{
  "name": "Search logs",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\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}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/logs/events/search",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "logs",
        "events",
        "search"
      ]
    },
    "description": "List endpoint returns logs that match a log search query.\n[Results are paginated][1].\n\nUse this endpoint to build complex logs filtering and search.\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": "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  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "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          \"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": "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  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events",
            "search"
          ]
        }
      },
      "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": "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  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events",
            "search"
          ]
        }
      },
      "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": "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  \"filter\": {\n    \"from\": \"now-15m\",\n    \"indexes\": [\n      \"*\"\n    ],\n    \"query\": \"*\",\n    \"storage_tier\": \"indexes\",\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/logs/events/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "logs",
            "events",
            "search"
          ]
        }
      },
      "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}"
    }
  ]
}