Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "dashboards": [
; {
; "type": "host_timeboard",
; "id": "<string>",
; "author": {
; "email": "<string>",
; "handle": "<string>",
; "name": "<string>"
; },
; "created": "<dateTime>",
; "icon": "<string>",
; "integration_id": "<string>",
; "is_favorite": "<boolean>",
; "is_read_only": "<boolean>",
; "is_shared": "<boolean>",
; "modified": "<dateTime>",
; "popularity": "<integer>",
; "tags": [
; "<string>",
; "<string>"
; ],
; "title": "<string>",
; "url": "<string>"
; },
; {
; "type": "custom_screenboard",
; "id": "<string>",
; "author": {
; "email": "<string>",
; "handle": "<string>",
; "name": "<string>"
; },
; "created": "<dateTime>",
; "icon": "<string>",
; "integration_id": "<string>",
; "is_favorite": "<boolean>",
; "is_read_only": "<boolean>",
; "is_shared": "<boolean>",
; "modified": "<dateTime>",
; "popularity": "<integer>",
; "tags": [
; "<string>",
; "<string>"
; ],
; "title": "<string>",
; "url": "<string>"
; }
; ],
; "total": "<long>"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sV_type
Local $sId
Local $sV_Email
Local $sHandle
Local $sName
Local $sCreated
Local $sIcon
Local $sIntegration_id
Local $sIs_favorite
Local $sIs_read_only
Local $sIs_shared
Local $sModified
Local $sPopularity
Local $sTitle
Local $sUrl
Local $iJ
Local $iCount_j
Local $strVal
Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("dashboards")
While $i < $iCount_i
$oJResp.I = $i
$sV_type = $oJResp.StringOf("dashboards[i].type")
$sId = $oJResp.StringOf("dashboards[i].id")
$sV_Email = $oJResp.StringOf("dashboards[i].author.email")
$sHandle = $oJResp.StringOf("dashboards[i].author.handle")
$sName = $oJResp.StringOf("dashboards[i].author.name")
$sCreated = $oJResp.StringOf("dashboards[i].created")
$sIcon = $oJResp.StringOf("dashboards[i].icon")
$sIntegration_id = $oJResp.StringOf("dashboards[i].integration_id")
$sIs_favorite = $oJResp.StringOf("dashboards[i].is_favorite")
$sIs_read_only = $oJResp.StringOf("dashboards[i].is_read_only")
$sIs_shared = $oJResp.StringOf("dashboards[i].is_shared")
$sModified = $oJResp.StringOf("dashboards[i].modified")
$sPopularity = $oJResp.StringOf("dashboards[i].popularity")
$sTitle = $oJResp.StringOf("dashboards[i].title")
$sUrl = $oJResp.StringOf("dashboards[i].url")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("dashboards[i].tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("dashboards[i].tags[j]")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards
Postman Collection Item JSON
{
"name": "Get items of a Dashboard List",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id",
"value": "<long>"
}
]
},
"description": "Fetch the dashboard list’s dashboard 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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"created\": \"<dateTime>\",\n \"icon\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"is_favorite\": \"<boolean>\",\n \"is_read_only\": \"<boolean>\",\n \"is_shared\": \"<boolean>\",\n \"modified\": \"<dateTime>\",\n \"popularity\": \"<integer>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"custom_screenboard\",\n \"id\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"created\": \"<dateTime>\",\n \"icon\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"is_favorite\": \"<boolean>\",\n \"is_read_only\": \"<boolean>\",\n \"is_shared\": \"<boolean>\",\n \"modified\": \"<dateTime>\",\n \"popularity\": \"<integer>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"total\": \"<long>\"\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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
