Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v1/events/:event_id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "event": {
; "alert_type": "info",
; "date_happened": -7687934,
; "device_name": "labore aliquip dolor",
; "host": "incididunt sunt",
; "id": -98412440,
; "id_str": "incididunt laborum",
; "payload": "{}",
; "priority": "normal",
; "source_type_name": "commodo cupidatat ea",
; "tags": [
; "environment:test"
; ],
; "text": "Oh boy!",
; "title": "Did you hear the news today?",
; "url": "non"
; },
; "status": "sit in"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
Alert_type.s = CkJsonObject::ckStringOf(jResp,"event.alert_type")
Date_happened.i = CkJsonObject::ckIntOf(jResp,"event.date_happened")
Device_name.s = CkJsonObject::ckStringOf(jResp,"event.device_name")
Host.s = CkJsonObject::ckStringOf(jResp,"event.host")
Id.i = CkJsonObject::ckIntOf(jResp,"event.id")
Id_str.s = CkJsonObject::ckStringOf(jResp,"event.id_str")
Payload.s = CkJsonObject::ckStringOf(jResp,"event.payload")
Priority.s = CkJsonObject::ckStringOf(jResp,"event.priority")
Source_type_name.s = CkJsonObject::ckStringOf(jResp,"event.source_type_name")
Text.s = CkJsonObject::ckStringOf(jResp,"event.text")
Title.s = CkJsonObject::ckStringOf(jResp,"event.title")
v_Url.s = CkJsonObject::ckStringOf(jResp,"event.url")
status.s = CkJsonObject::ckStringOf(jResp,"status")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"event.tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"event.tags[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/events/:event_id
Postman Collection Item JSON
{
"name": "Get an event",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/events/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events",
":event_id"
],
"variable": [
{
"key": "event_id",
"value": "-62147425"
}
]
},
"description": "This endpoint allows you to query for event details.\n\n**Note**: If the event you’re querying contains markdown formatting of any kind,\nyou may see characters such as `%`,`\\`,`n` in your output."
},
"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/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"event\": {\n \"alert_type\": \"info\",\n \"date_happened\": -7687934,\n \"device_name\": \"labore aliquip dolor\",\n \"host\": \"incididunt sunt\",\n \"id\": -98412440,\n \"id_str\": \"incididunt laborum\",\n \"payload\": \"{}\",\n \"priority\": \"normal\",\n \"source_type_name\": \"commodo cupidatat ea\",\n \"tags\": [\n \"environment:test\"\n ],\n \"text\": \"Oh boy!\",\n \"title\": \"Did you hear the news today?\",\n \"url\": \"non\"\n },\n \"status\": \"sit in\"\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/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"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": "Item Not Found",
"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/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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/:event_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"events",
":event_id"
],
"variable": [
{
"key": "event_id"
}
]
}
},
"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}"
}
]
}
