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/v1/dashboard/:dashboard_id",$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)
; {
; "title": "",
; "layout_type": "ordered",
; "widgets": [
; {
; "definition": {
; "type": "alert_graph",
; "alert_id": "",
; "viz_type": "timeseries",
; "time": {
; "live_span": "5m"
; },
; "title": "nisi et cupidatat sunt",
; "title_align": "right",
; "title_size": "officia anim occaecat aliq"
; },
; "id": 45068649,
; "layout": {
; "x": 0,
; "y": 0,
; "width": 0,
; "height": 0,
; "is_column_break": true
; }
; },
; {
; "definition": {
; "type": "alert_graph",
; "alert_id": "",
; "viz_type": "timeseries",
; "time": {
; "live_span": "5m"
; },
; "title": "laborum dolor cillum ad",
; "title_align": "center",
; "title_size": "et"
; },
; "id": -40196020,
; "layout": {
; "x": 0,
; "y": 0,
; "width": 0,
; "height": 0,
; "is_column_break": false
; }
; }
; ],
; "author_handle": "test@datadoghq.com",
; "author_name": "John Doe",
; "created_at": "2017-08-17T07:10:36.438Z",
; "description": "eiusmod do est velit enim",
; "id": "123-abc-456",
; "is_read_only": false,
; "modified_at": "1996-07-08T08:32:43.112Z",
; "notify_list": [
; "commodo voluptate eu",
; "consectetur amet"
; ],
; "reflow_type": "fixed",
; "restricted_roles": [
; "id cupidatat",
; "quis ullamco"
; ],
; "tags": [
; "quis qui mollit ex",
; "ullamco enim cupidatat"
; ],
; "template_variable_presets": [
; {
; "name": "Lorem ex enim",
; "template_variables": [
; {
; "name": "sed ",
; "value": "quis eu",
; "values": [
; "in"
; ]
; },
; {
; "name": "non",
; "value": "ea dolore esse elit Lorem",
; "values": [
; "sed voluptate nulla"
; ]
; }
; ]
; },
; {
; "name": "est ",
; "template_variables": [
; {
; "name": "ullamco sint",
; "value": "ad ex irure",
; "values": [
; "Duis elit dolor"
; ]
; },
; {
; "name": "proident adipisicing culpa cons",
; "value": "occaecat",
; "values": [
; "esse fugiat"
; ]
; }
; ]
; }
; ],
; "template_variables": [
; {
; "name": "host1",
; "available_values": [
; "my-host",
; "host1",
; "host2"
; ],
; "default": "my-host",
; "defaults": [
; "my-host-1",
; "my-host-2"
; ],
; "prefix": "host"
; },
; {
; "name": "host1",
; "available_values": [
; "my-host",
; "host1",
; "host2"
; ],
; "default": "my-host",
; "defaults": [
; "my-host-1",
; "my-host-2"
; ],
; "prefix": "host"
; }
; ],
; "url": "/dashboard/123-abc-456/example-dashboard-title"
; }
; 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 $sAlert_id
Local $sViz_type
Local $sLive_span
Local $sTitle
Local $sTitle_align
Local $sTitle_size
Local $id_int
Local $iX
Local $iY
Local $iWidth
Local $iHeight
Local $bIs_column_break
Local $strVal
Local $sName
Local $iJ
Local $iCount_j
Local $sValue
Local $iK
Local $iCount_k
Local $sDefault
Local $sPrefix
Local $sTitle = $oJResp.StringOf("title")
Local $sLayout_type = $oJResp.StringOf("layout_type")
Local $sAuthor_handle = $oJResp.StringOf("author_handle")
Local $sAuthor_name = $oJResp.StringOf("author_name")
Local $sCreated_at = $oJResp.StringOf("created_at")
Local $sDescription = $oJResp.StringOf("description")
Local $sId = $oJResp.StringOf("id")
Local $bIs_read_only = $oJResp.BoolOf("is_read_only")
Local $sModified_at = $oJResp.StringOf("modified_at")
Local $sReflow_type = $oJResp.StringOf("reflow_type")
Local $sUrl = $oJResp.StringOf("url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("widgets")
While $i < $iCount_i
$oJResp.I = $i
$sV_Type = $oJResp.StringOf("widgets[i].definition.type")
$sAlert_id = $oJResp.StringOf("widgets[i].definition.alert_id")
$sViz_type = $oJResp.StringOf("widgets[i].definition.viz_type")
$sLive_span = $oJResp.StringOf("widgets[i].definition.time.live_span")
$sTitle = $oJResp.StringOf("widgets[i].definition.title")
$sTitle_align = $oJResp.StringOf("widgets[i].definition.title_align")
$sTitle_size = $oJResp.StringOf("widgets[i].definition.title_size")
$id_int = $oJResp.IntOf("widgets[i].id")
$iX = $oJResp.IntOf("widgets[i].layout.x")
$iY = $oJResp.IntOf("widgets[i].layout.y")
$iWidth = $oJResp.IntOf("widgets[i].layout.width")
$iHeight = $oJResp.IntOf("widgets[i].layout.height")
$bIs_column_break = $oJResp.BoolOf("widgets[i].layout.is_column_break")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("notify_list")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("notify_list[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("restricted_roles")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("restricted_roles[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("tags")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("tags[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("template_variable_presets")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("template_variable_presets[i].name")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("template_variable_presets[i].template_variables")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sName = $oJResp.StringOf("template_variable_presets[i].template_variables[j].name")
$sValue = $oJResp.StringOf("template_variable_presets[i].template_variables[j].value")
$iK = 0
$iCount_k = $oJResp.SizeOfArray("template_variable_presets[i].template_variables[j].values")
While $iK < $iCount_k
$oJResp.K = $iK
$strVal = $oJResp.StringOf("template_variable_presets[i].template_variables[j].values[k]")
$iK = $iK + 1
Wend
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("template_variables")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("template_variables[i].name")
$sDefault = $oJResp.StringOf("template_variables[i].default")
$sPrefix = $oJResp.StringOf("template_variables[i].prefix")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("template_variables[i].available_values")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("template_variables[i].available_values[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("template_variables[i].defaults")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("template_variables[i].defaults[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/v1/dashboard/:dashboard_id
Postman Collection Item JSON
{
"name": "Get a dashboard",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Get a dashboard using the specified ID."
},
"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/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"title\": \"\",\n \"layout_type\": \"ordered\",\n \"widgets\": [\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"nisi et cupidatat sunt\",\n \"title_align\": \"right\",\n \"title_size\": \"officia anim occaecat aliq\"\n },\n \"id\": 45068649,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": true\n }\n },\n {\n \"definition\": {\n \"type\": \"alert_graph\",\n \"alert_id\": \"\",\n \"viz_type\": \"timeseries\",\n \"time\": {\n \"live_span\": \"5m\"\n },\n \"title\": \"laborum dolor cillum ad\",\n \"title_align\": \"center\",\n \"title_size\": \"et\"\n },\n \"id\": -40196020,\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"width\": 0,\n \"height\": 0,\n \"is_column_break\": false\n }\n }\n ],\n \"author_handle\": \"test@datadoghq.com\",\n \"author_name\": \"John Doe\",\n \"created_at\": \"2017-08-17T07:10:36.438Z\",\n \"description\": \"eiusmod do est velit enim\",\n \"id\": \"123-abc-456\",\n \"is_read_only\": false,\n \"modified_at\": \"1996-07-08T08:32:43.112Z\",\n \"notify_list\": [\n \"commodo voluptate eu\",\n \"consectetur amet\"\n ],\n \"reflow_type\": \"fixed\",\n \"restricted_roles\": [\n \"id cupidatat\",\n \"quis ullamco\"\n ],\n \"tags\": [\n \"quis qui mollit ex\",\n \"ullamco enim cupidatat\"\n ],\n \"template_variable_presets\": [\n {\n \"name\": \"Lorem ex enim\",\n \"template_variables\": [\n {\n \"name\": \"sed \",\n \"value\": \"quis eu\",\n \"values\": [\n \"in\"\n ]\n },\n {\n \"name\": \"non\",\n \"value\": \"ea dolore esse elit Lorem\",\n \"values\": [\n \"sed voluptate nulla\"\n ]\n }\n ]\n },\n {\n \"name\": \"est \",\n \"template_variables\": [\n {\n \"name\": \"ullamco sint\",\n \"value\": \"ad ex irure\",\n \"values\": [\n \"Duis elit dolor\"\n ]\n },\n {\n \"name\": \"proident adipisicing culpa cons\",\n \"value\": \"occaecat\",\n \"values\": [\n \"esse fugiat\"\n ]\n }\n ]\n }\n ],\n \"template_variables\": [\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"default\": \"my-host\",\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n },\n {\n \"name\": \"host1\",\n \"available_values\": [\n \"my-host\",\n \"host1\",\n \"host2\"\n ],\n \"default\": \"my-host\",\n \"defaults\": [\n \"my-host-1\",\n \"my-host-2\"\n ],\n \"prefix\": \"host\"\n }\n ],\n \"url\": \"/dashboard/123-abc-456/example-dashboard-title\"\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/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_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/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_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/dashboard/:dashboard_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
":dashboard_id"
],
"variable": [
{
"key": "dashboard_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}"
}
]
}
