Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
alert_type: PWideChar;
date_happened: Integer;
device_name: PWideChar;
host: PWideChar;
id: Integer;
id_str: PWideChar;
payload: PWideChar;
priority: PWideChar;
source_type_name: PWideChar;
text: PWideChar;
title: PWideChar;
url: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
status: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateInt(queryParams,'start',-62147425);
CkJsonObject_UpdateInt(queryParams,'end',-62147425);
CkJsonObject_UpdateString(queryParams,'priority','normal');
CkJsonObject_UpdateString(queryParams,'sources','tempor Ut sed velit');
CkJsonObject_UpdateString(queryParams,'tags','host:host0');
CkJsonObject_UpdateString(queryParams,'unaggregated','true');
CkJsonObject_UpdateString(queryParams,'exclude_aggregate','true');
CkJsonObject_UpdateInt(queryParams,'page',-90656756);
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.app.ddog-gov.com/api/v1/events',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
status := CkJsonObject__stringOf(jResp,'status');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'events');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
alert_type := CkJsonObject__stringOf(jResp,'events[i].alert_type');
date_happened := CkJsonObject_IntOf(jResp,'events[i].date_happened');
device_name := CkJsonObject__stringOf(jResp,'events[i].device_name');
host := CkJsonObject__stringOf(jResp,'events[i].host');
id := CkJsonObject_IntOf(jResp,'events[i].id');
id_str := CkJsonObject__stringOf(jResp,'events[i].id_str');
payload := CkJsonObject__stringOf(jResp,'events[i].payload');
priority := CkJsonObject__stringOf(jResp,'events[i].priority');
source_type_name := CkJsonObject__stringOf(jResp,'events[i].source_type_name');
text := CkJsonObject__stringOf(jResp,'events[i].text');
title := CkJsonObject__stringOf(jResp,'events[i].title');
url := CkJsonObject__stringOf(jResp,'events[i].url');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'events[i].tags');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'events[i].tags[j]');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
