Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcAlert_id
LOCAL lcViz_type
LOCAL lcLive_span
LOCAL lcTitle
LOCAL lcTitle_align
LOCAL lcTitle_size
LOCAL lnId_int
LOCAL X
LOCAL Y
LOCAL lnWidth
LOCAL lnHeight
LOCAL lnIs_column_break
LOCAL lcStrVal
LOCAL lcName
LOCAL j
LOCAL lnCount_j
LOCAL lcValue
LOCAL k
LOCAL lnCount_k
LOCAL lcDefault
LOCAL lcPrefix
LOCAL lcTitle
LOCAL lcLayout_type
LOCAL lcAuthor_handle
LOCAL lcAuthor_name
LOCAL lcCreated_at
LOCAL lcDescription
LOCAL lcId
LOCAL lnIs_read_only
LOCAL lcModified_at
LOCAL lcReflow_type
LOCAL lcUrl
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v1/dashboard/:dashboard_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcTitle = loJResp.StringOf("title")
lcLayout_type = loJResp.StringOf("layout_type")
lcAuthor_handle = loJResp.StringOf("author_handle")
lcAuthor_name = loJResp.StringOf("author_name")
lcCreated_at = loJResp.StringOf("created_at")
lcDescription = loJResp.StringOf("description")
lcId = loJResp.StringOf("id")
lnIs_read_only = loJResp.BoolOf("is_read_only")
lcModified_at = loJResp.StringOf("modified_at")
lcReflow_type = loJResp.StringOf("reflow_type")
lcUrl = loJResp.StringOf("url")
i = 0
lnCount_i = loJResp.SizeOfArray("widgets")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_Type = loJResp.StringOf("widgets[i].definition.type")
lcAlert_id = loJResp.StringOf("widgets[i].definition.alert_id")
lcViz_type = loJResp.StringOf("widgets[i].definition.viz_type")
lcLive_span = loJResp.StringOf("widgets[i].definition.time.live_span")
lcTitle = loJResp.StringOf("widgets[i].definition.title")
lcTitle_align = loJResp.StringOf("widgets[i].definition.title_align")
lcTitle_size = loJResp.StringOf("widgets[i].definition.title_size")
lnId_int = loJResp.IntOf("widgets[i].id")
X = loJResp.IntOf("widgets[i].layout.x")
Y = loJResp.IntOf("widgets[i].layout.y")
lnWidth = loJResp.IntOf("widgets[i].layout.width")
lnHeight = loJResp.IntOf("widgets[i].layout.height")
lnIs_column_break = loJResp.BoolOf("widgets[i].layout.is_column_break")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("notify_list")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("notify_list[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("restricted_roles")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("restricted_roles[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("tags")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("tags[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("template_variable_presets")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("template_variable_presets[i].name")
j = 0
lnCount_j = loJResp.SizeOfArray("template_variable_presets[i].template_variables")
DO WHILE j < lnCount_j
loJResp.J = j
lcName = loJResp.StringOf("template_variable_presets[i].template_variables[j].name")
lcValue = loJResp.StringOf("template_variable_presets[i].template_variables[j].value")
k = 0
lnCount_k = loJResp.SizeOfArray("template_variable_presets[i].template_variables[j].values")
DO WHILE k < lnCount_k
loJResp.K = k
lcStrVal = loJResp.StringOf("template_variable_presets[i].template_variables[j].values[k]")
k = k + 1
ENDDO
j = j + 1
ENDDO
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("template_variables")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("template_variables[i].name")
lcDefault = loJResp.StringOf("template_variables[i].default")
lcPrefix = loJResp.StringOf("template_variables[i].prefix")
j = 0
lnCount_j = loJResp.SizeOfArray("template_variables[i].available_values")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("template_variables[i].available_values[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("template_variables[i].defaults")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("template_variables[i].defaults[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
