Chilkat Online Tools

Xojo / Datadog API Collection / Get a list of logs

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("filter[query]","<string>")
success = queryParams.UpdateString("filter[indexes]","<string>,<string>")
success = queryParams.UpdateString("filter[from]","<dateTime>")
success = queryParams.UpdateString("filter[to]","<dateTime>")
success = queryParams.UpdateString("filter[storage_tier]","indexes")
success = queryParams.UpdateString("sort","-timestamp")
success = queryParams.UpdateString("page[cursor]","<string>")
success = queryParams.UpdateInt("page[limit]",10)

http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/logs/events",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

Dim Host As String
Dim Message As String
Dim Service As String
Dim attributesStatus As String
Dim Timestamp As String
Dim id As String
Dim v_type As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String
Dim code As String
Dim detail As String
Dim title As String

Dim v_Next As String
v_Next = jResp.StringOf("links.next")
Dim Elapsed As String
Elapsed = jResp.StringOf("meta.elapsed")
Dim After As String
After = jResp.StringOf("meta.page.after")
Dim Request_id As String
Request_id = jResp.StringOf("meta.request_id")
Dim Status As String
Status = jResp.StringOf("meta.status")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("data")
While i < count_i
    jResp.I = i
    Host = jResp.StringOf("data[i].attributes.host")
    Message = jResp.StringOf("data[i].attributes.message")
    Service = jResp.StringOf("data[i].attributes.service")
    attributesStatus = jResp.StringOf("data[i].attributes.status")
    Timestamp = jResp.StringOf("data[i].attributes.timestamp")
    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
    Wend
    i = i + 1
Wend
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
Wend

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