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/dashboard/lists/manual",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)
; {
; "dashboard_lists": [
; {
; "name": "My Dashboard",
; "author": {
; "email": "reprehenderit nostrud",
; "handle": "qui officia tempor",
; "name": "ex"
; },
; "created": "1963-08-11T12:15:03.407Z",
; "dashboard_count": -63891965,
; "id": -37288260,
; "is_favorite": true,
; "modified": "1993-02-16T23:18:05.785Z",
; "type": "manual_dashboard_list"
; },
; {
; "name": "My Dashboard",
; "author": {
; "email": "Duis reprehenderit est",
; "handle": "consequat qui esse incididunt",
; "name": "qui non ad"
; },
; "created": "2012-05-31T22:35:18.125Z",
; "dashboard_count": -45121707,
; "id": -45358157,
; "is_favorite": false,
; "modified": "1966-04-15T02:24:29.676Z",
; "type": "manual_dashboard_list"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
name.s
v_Email.s
Handle.s
Name.s
created.s
dashboard_count.i
id.i
is_favorite.i
modified.s
v_type.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"dashboard_lists")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"dashboard_lists[i].name")
v_Email = CkJsonObject::ckStringOf(jResp,"dashboard_lists[i].author.email")
Handle = CkJsonObject::ckStringOf(jResp,"dashboard_lists[i].author.handle")
Name = CkJsonObject::ckStringOf(jResp,"dashboard_lists[i].author.name")
created = CkJsonObject::ckStringOf(jResp,"dashboard_lists[i].created")
dashboard_count = CkJsonObject::ckIntOf(jResp,"dashboard_lists[i].dashboard_count")
id = CkJsonObject::ckIntOf(jResp,"dashboard_lists[i].id")
is_favorite = CkJsonObject::ckBoolOf(jResp,"dashboard_lists[i].is_favorite")
modified = CkJsonObject::ckStringOf(jResp,"dashboard_lists[i].modified")
v_type = CkJsonObject::ckStringOf(jResp,"dashboard_lists[i].type")
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/dashboard/lists/manual
Postman Collection Item JSON
{
"name": "Get all dashboard lists",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
},
"description": "Fetch all of your existing dashboard list definitions."
},
"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/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dashboard_lists\": [\n {\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"reprehenderit nostrud\",\n \"handle\": \"qui officia tempor\",\n \"name\": \"ex\"\n },\n \"created\": \"1963-08-11T12:15:03.407Z\",\n \"dashboard_count\": -63891965,\n \"id\": -37288260,\n \"is_favorite\": true,\n \"modified\": \"1993-02-16T23:18:05.785Z\",\n \"type\": \"manual_dashboard_list\"\n },\n {\n \"name\": \"My Dashboard\",\n \"author\": {\n \"email\": \"Duis reprehenderit est\",\n \"handle\": \"consequat qui esse incididunt\",\n \"name\": \"qui non ad\"\n },\n \"created\": \"2012-05-31T22:35:18.125Z\",\n \"dashboard_count\": -45121707,\n \"id\": -45358157,\n \"is_favorite\": false,\n \"modified\": \"1966-04-15T02:24:29.676Z\",\n \"type\": \"manual_dashboard_list\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"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/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"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/dashboard/lists/manual",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"lists",
"manual"
]
}
},
"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}"
}
]
}