Chilkat Online Tools

Xojo / Datadog API Collection / Get a list of events

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.UpdateInt("start",-62147425)
success = queryParams.UpdateInt("end",-62147425)
success = queryParams.UpdateString("priority","normal")
success = queryParams.UpdateString("sources","tempor Ut sed velit")
success = queryParams.UpdateString("tags","host:host0")
success = queryParams.UpdateString("unaggregated","true")
success = queryParams.UpdateString("exclude_aggregate","true")
success = queryParams.UpdateInt("page",-90656756)

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

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/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)

// {
//   "events": [
//     {
//       "alert_type": "info",
//       "date_happened": -60006686,
//       "device_name": "dolore",
//       "host": "proident in",
//       "id": -22759649,
//       "id_str": "quis labore cupidatat minim",
//       "payload": "{}",
//       "priority": "normal",
//       "source_type_name": "nulla aute",
//       "tags": [
//         "environment:test"
//       ],
//       "text": "Oh boy!",
//       "title": "Did you hear the news today?",
//       "url": "ex"
//     },
//     {
//       "alert_type": "info",
//       "date_happened": 12830805,
//       "device_name": "incididunt",
//       "host": "ex Excepteur eu magna",
//       "id": -86397972,
//       "id_str": "Duis",
//       "payload": "{}",
//       "priority": "normal",
//       "source_type_name": "quis amet voluptate fugiat enim",
//       "tags": [
//         "environment:test"
//       ],
//       "text": "Oh boy!",
//       "title": "Did you hear the news today?",
//       "url": "tempor"
//     }
//   ],
//   "status": "laborum consequat"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim alert_type As String
Dim date_happened As Int32
Dim device_name As String
Dim host As String
Dim id As Int32
Dim id_str As String
Dim payload As String
Dim priority As String
Dim source_type_name As String
Dim text As String
Dim title As String
Dim url As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String

Dim status As String
status = jResp.StringOf("status")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("events")
While i < count_i
    jResp.I = i
    alert_type = jResp.StringOf("events[i].alert_type")
    date_happened = jResp.IntOf("events[i].date_happened")
    device_name = jResp.StringOf("events[i].device_name")
    host = jResp.StringOf("events[i].host")
    id = jResp.IntOf("events[i].id")
    id_str = jResp.StringOf("events[i].id_str")
    payload = jResp.StringOf("events[i].payload")
    priority = jResp.StringOf("events[i].priority")
    source_type_name = jResp.StringOf("events[i].source_type_name")
    text = jResp.StringOf("events[i].text")
    title = jResp.StringOf("events[i].title")
    url = jResp.StringOf("events[i].url")
    j = 0
    count_j = jResp.SizeOfArray("events[i].tags")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("events[i].tags[j]")
        j = j + 1
    Wend
    i = i + 1
Wend

Curl Command

curl -G -d "start=-62147425"
	-d "end=-62147425"
	-d "priority=normal"
	-d "sources=tempor%20Ut%20sed%20velit"
	-d "tags=host%3Ahost0"
	-d "unaggregated=true"
	-d "exclude_aggregate=true"
	-d "page=-90656756"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/events

Postman Collection Item JSON

{
  "name": "Get a list of events",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/events?start=-62147425&end=-62147425&priority=normal&sources=tempor Ut sed velit&tags=host:host0&unaggregated=true&exclude_aggregate=true&page=-90656756",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "events"
      ],
      "query": [
        {
          "key": "start",
          "value": "-62147425",
          "description": "(Required) POSIX timestamp."
        },
        {
          "key": "end",
          "value": "-62147425",
          "description": "(Required) POSIX timestamp."
        },
        {
          "key": "priority",
          "value": "normal",
          "description": "Priority of your events, either `low` or `normal`."
        },
        {
          "key": "sources",
          "value": "tempor Ut sed velit",
          "description": "A comma separated string of sources."
        },
        {
          "key": "tags",
          "value": "host:host0",
          "description": "A comma separated list indicating what tags, if any, should be used to filter the list of events."
        },
        {
          "key": "unaggregated",
          "value": "true",
          "description": "Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe.\nOtherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe,\nit won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`"
        },
        {
          "key": "exclude_aggregate",
          "value": "true",
          "description": "Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`,\nthen the unaggregated parameter is ignored and will be `true` by default."
        },
        {
          "key": "page",
          "value": "-90656756",
          "description": "By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used\nwhen either unaggregated or exclude_aggregate is set to `true.`"
        }
      ]
    },
    "description": "The event stream can be queried and filtered by time, priority, sources and tags.\n\n**Notes**:\n- If the event you’re querying contains markdown formatting of any kind,\nyou may see characters such as `%`,`\\`,`n` in your output.\n\n- This endpoint returns a maximum of `1000` most recent results. To return additional results,\nidentify the last timestamp of the last result and set that as the `end` query time to\npaginate the results. You can also use the page parameter to specify which set of `1000` results to return."
  },
  "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/v1/events?start=-62147425&end=-62147425&priority=normal&sources=tempor Ut sed velit&tags=host:host0&unaggregated=true&exclude_aggregate=true&page=-90656756",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "events"
          ],
          "query": [
            {
              "key": "start",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "end",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "priority",
              "value": "normal",
              "description": "Priority of your events, either `low` or `normal`."
            },
            {
              "key": "sources",
              "value": "tempor Ut sed velit",
              "description": "A comma separated string of sources."
            },
            {
              "key": "tags",
              "value": "host:host0",
              "description": "A comma separated list indicating what tags, if any, should be used to filter the list of events."
            },
            {
              "key": "unaggregated",
              "value": "true",
              "description": "Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe.\nOtherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe,\nit won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`"
            },
            {
              "key": "exclude_aggregate",
              "value": "true",
              "description": "Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`,\nthen the unaggregated parameter is ignored and will be `true` by default."
            },
            {
              "key": "page",
              "value": "-90656756",
              "description": "By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used\nwhen either unaggregated or exclude_aggregate is set to `true.`"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"events\": [\n    {\n      \"alert_type\": \"info\",\n      \"date_happened\": -60006686,\n      \"device_name\": \"dolore\",\n      \"host\": \"proident in\",\n      \"id\": -22759649,\n      \"id_str\": \"quis labore cupidatat minim\",\n      \"payload\": \"{}\",\n      \"priority\": \"normal\",\n      \"source_type_name\": \"nulla aute\",\n      \"tags\": [\n        \"environment:test\"\n      ],\n      \"text\": \"Oh boy!\",\n      \"title\": \"Did you hear the news today?\",\n      \"url\": \"ex\"\n    },\n    {\n      \"alert_type\": \"info\",\n      \"date_happened\": 12830805,\n      \"device_name\": \"incididunt\",\n      \"host\": \"ex Excepteur eu magna\",\n      \"id\": -86397972,\n      \"id_str\": \"Duis\",\n      \"payload\": \"{}\",\n      \"priority\": \"normal\",\n      \"source_type_name\": \"quis amet voluptate fugiat enim\",\n      \"tags\": [\n        \"environment:test\"\n      ],\n      \"text\": \"Oh boy!\",\n      \"title\": \"Did you hear the news today?\",\n      \"url\": \"tempor\"\n    }\n  ],\n  \"status\": \"laborum consequat\"\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/v1/events?start=-62147425&end=-62147425&priority=normal&sources=tempor Ut sed velit&tags=host:host0&unaggregated=true&exclude_aggregate=true&page=-90656756",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "events"
          ],
          "query": [
            {
              "key": "start",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "end",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "priority",
              "value": "normal",
              "description": "Priority of your events, either `low` or `normal`."
            },
            {
              "key": "sources",
              "value": "tempor Ut sed velit",
              "description": "A comma separated string of sources."
            },
            {
              "key": "tags",
              "value": "host:host0",
              "description": "A comma separated list indicating what tags, if any, should be used to filter the list of events."
            },
            {
              "key": "unaggregated",
              "value": "true",
              "description": "Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe.\nOtherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe,\nit won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`"
            },
            {
              "key": "exclude_aggregate",
              "value": "true",
              "description": "Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`,\nthen the unaggregated parameter is ignored and will be `true` by default."
            },
            {
              "key": "page",
              "value": "-90656756",
              "description": "By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used\nwhen either unaggregated or exclude_aggregate is set to `true.`"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Authentication Error",
      "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/v1/events?start=-62147425&end=-62147425&priority=normal&sources=tempor Ut sed velit&tags=host:host0&unaggregated=true&exclude_aggregate=true&page=-90656756",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "events"
          ],
          "query": [
            {
              "key": "start",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "end",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "priority",
              "value": "normal",
              "description": "Priority of your events, either `low` or `normal`."
            },
            {
              "key": "sources",
              "value": "tempor Ut sed velit",
              "description": "A comma separated string of sources."
            },
            {
              "key": "tags",
              "value": "host:host0",
              "description": "A comma separated list indicating what tags, if any, should be used to filter the list of events."
            },
            {
              "key": "unaggregated",
              "value": "true",
              "description": "Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe.\nOtherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe,\nit won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`"
            },
            {
              "key": "exclude_aggregate",
              "value": "true",
              "description": "Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`,\nthen the unaggregated parameter is ignored and will be `true` by default."
            },
            {
              "key": "page",
              "value": "-90656756",
              "description": "By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used\nwhen either unaggregated or exclude_aggregate is set to `true.`"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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/v1/events?start=-62147425&end=-62147425&priority=normal&sources=tempor Ut sed velit&tags=host:host0&unaggregated=true&exclude_aggregate=true&page=-90656756",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "events"
          ],
          "query": [
            {
              "key": "start",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "end",
              "value": "-62147425",
              "description": "(Required) POSIX timestamp."
            },
            {
              "key": "priority",
              "value": "normal",
              "description": "Priority of your events, either `low` or `normal`."
            },
            {
              "key": "sources",
              "value": "tempor Ut sed velit",
              "description": "A comma separated string of sources."
            },
            {
              "key": "tags",
              "value": "host:host0",
              "description": "A comma separated list indicating what tags, if any, should be used to filter the list of events."
            },
            {
              "key": "unaggregated",
              "value": "true",
              "description": "Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe.\nOtherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe,\nit won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`"
            },
            {
              "key": "exclude_aggregate",
              "value": "true",
              "description": "Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`,\nthen the unaggregated parameter is ignored and will be `true` by default."
            },
            {
              "key": "page",
              "value": "-90656756",
              "description": "By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used\nwhen either unaggregated or exclude_aggregate is set to `true.`"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}