Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sV_Email
String sHandle
String sName
String sCreated
Integer iDashboard_count
Integer iId
Boolean iIs_favorite
String sModified
String sV_type
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.app.ddog-gov.com/api/v1/dashboard/lists/manual" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "dashboard_lists" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "dashboard_lists[i].name" To sName
Get ComStringOf Of hoJResp "dashboard_lists[i].author.email" To sV_Email
Get ComStringOf Of hoJResp "dashboard_lists[i].author.handle" To sHandle
Get ComStringOf Of hoJResp "dashboard_lists[i].author.name" To sName
Get ComStringOf Of hoJResp "dashboard_lists[i].created" To sCreated
Get ComIntOf Of hoJResp "dashboard_lists[i].dashboard_count" To iDashboard_count
Get ComIntOf Of hoJResp "dashboard_lists[i].id" To iId
Get ComBoolOf Of hoJResp "dashboard_lists[i].is_favorite" To iIs_favorite
Get ComStringOf Of hoJResp "dashboard_lists[i].modified" To sModified
Get ComStringOf Of hoJResp "dashboard_lists[i].type" To sV_type
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
