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
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("filter[shared]","false")
$oQueryParams.UpdateString("filter[deleted]","false")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/dashboard",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "dashboards": [
; {
; "author_handle": "Duis tempor ex",
; "created_at": "1963-12-20T01:10:02.870Z",
; "description": "esse cillum laboris",
; "id": "do Ut",
; "is_read_only": true,
; "layout_type": "ordered",
; "modified_at": "1958-09-05T14:28:29.291Z",
; "title": "nulla velit tempor",
; "url": "quis laboris irure id"
; },
; {
; "author_handle": "cup",
; "created_at": "1992-05-21T18:14:01.464Z",
; "description": "proident incididunt dolore",
; "id": "in deserunt irure",
; "is_read_only": false,
; "layout_type": "ordered",
; "modified_at": "1971-12-02T02:50:20.074Z",
; "title": "ut dolor in consequat fugiat",
; "url": "culpa Duis mollit"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sAuthor_handle
Local $sCreated_at
Local $sDescription
Local $sId
Local $bIs_read_only
Local $sLayout_type
Local $sModified_at
Local $sTitle
Local $sUrl
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("dashboards")
While $i < $iCount_i
$oJResp.I = $i
$sAuthor_handle = $oJResp.StringOf("dashboards[i].author_handle")
$sCreated_at = $oJResp.StringOf("dashboards[i].created_at")
$sDescription = $oJResp.StringOf("dashboards[i].description")
$sId = $oJResp.StringOf("dashboards[i].id")
$bIs_read_only = $oJResp.BoolOf("dashboards[i].is_read_only")
$sLayout_type = $oJResp.StringOf("dashboards[i].layout_type")
$sModified_at = $oJResp.StringOf("dashboards[i].modified_at")
$sTitle = $oJResp.StringOf("dashboards[i].title")
$sUrl = $oJResp.StringOf("dashboards[i].url")
$i = $i + 1
Wend
Curl Command
curl -G -d "filter[shared]=false"
-d "filter[deleted]=false"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/dashboard
Postman Collection Item JSON
{
"name": "Get all dashboards",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard?filter[shared]=false&filter[deleted]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "false",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
}
]
},
"description": "Get all dashboards.\n\n**Note**: This query will only return custom created or cloned dashboards.\nThis query will not return preset dashboards."
},
"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?filter[shared]=false&filter[deleted]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "false",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dashboards\": [\n {\n \"author_handle\": \"Duis tempor ex\",\n \"created_at\": \"1963-12-20T01:10:02.870Z\",\n \"description\": \"esse cillum laboris\",\n \"id\": \"do Ut\",\n \"is_read_only\": true,\n \"layout_type\": \"ordered\",\n \"modified_at\": \"1958-09-05T14:28:29.291Z\",\n \"title\": \"nulla velit tempor\",\n \"url\": \"quis laboris irure id\"\n },\n {\n \"author_handle\": \"cup\",\n \"created_at\": \"1992-05-21T18:14:01.464Z\",\n \"description\": \"proident incididunt dolore\",\n \"id\": \"in deserunt irure\",\n \"is_read_only\": false,\n \"layout_type\": \"ordered\",\n \"modified_at\": \"1971-12-02T02:50:20.074Z\",\n \"title\": \"ut dolor in consequat fugiat\",\n \"url\": \"culpa Duis mollit\"\n }\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/dashboard?filter[shared]=false&filter[deleted]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "false",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
}
]
}
},
"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?filter[shared]=false&filter[deleted]=false",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
],
"query": [
{
"key": "filter[shared]",
"value": "false",
"description": "When `true`, this query only returns shared custom created\nor cloned dashboards."
},
{
"key": "filter[deleted]",
"value": "false",
"description": "When `true`, this query returns only deleted custom-created\nor cloned dashboards. This parameter is incompatible with `filter[shared]`."
}
]
}
},
"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}"
}
]
}
