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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(queryParams,"start",-62147425)
CkJsonObject::ckUpdateInt(queryParams,"end",-62147425)
CkJsonObject::ckUpdateString(queryParams,"priority","normal")
CkJsonObject::ckUpdateString(queryParams,"sources","tempor Ut sed velit")
CkJsonObject::ckUpdateString(queryParams,"tags","host:host0")
CkJsonObject::ckUpdateString(queryParams,"unaggregated","true")
CkJsonObject::ckUpdateString(queryParams,"exclude_aggregate","true")
CkJsonObject::ckUpdateInt(queryParams,"page",-90656756)
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v1/events",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
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(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
alert_type.s
date_happened.i
device_name.s
host.s
id.i
id_str.s
payload.s
priority.s
source_type_name.s
text.s
title.s
url.s
j.i
count_j.i
strVal.s
status.s = CkJsonObject::ckStringOf(jResp,"status")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"events")
While i < count_i
CkJsonObject::setCkI(jResp, i)
alert_type = CkJsonObject::ckStringOf(jResp,"events[i].alert_type")
date_happened = CkJsonObject::ckIntOf(jResp,"events[i].date_happened")
device_name = CkJsonObject::ckStringOf(jResp,"events[i].device_name")
host = CkJsonObject::ckStringOf(jResp,"events[i].host")
id = CkJsonObject::ckIntOf(jResp,"events[i].id")
id_str = CkJsonObject::ckStringOf(jResp,"events[i].id_str")
payload = CkJsonObject::ckStringOf(jResp,"events[i].payload")
priority = CkJsonObject::ckStringOf(jResp,"events[i].priority")
source_type_name = CkJsonObject::ckStringOf(jResp,"events[i].source_type_name")
text = CkJsonObject::ckStringOf(jResp,"events[i].text")
title = CkJsonObject::ckStringOf(jResp,"events[i].title")
url = CkJsonObject::ckStringOf(jResp,"events[i].url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"events[i].tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"events[i].tags[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
