Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v1/dashboard/:dashboard_id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
v_Type.s
Alert_id.s
Viz_type.s
Live_span.s
Title.s
Title_align.s
Title_size.s
id_int.i
X.i
Y.i
Width.i
Height.i
Is_column_break.i
strVal.s
name.s
j.i
count_j.i
value.s
k.i
count_k.i
default.s
prefix.s
title.s = CkJsonObject::ckStringOf(jResp,"title")
layout_type.s = CkJsonObject::ckStringOf(jResp,"layout_type")
author_handle.s = CkJsonObject::ckStringOf(jResp,"author_handle")
author_name.s = CkJsonObject::ckStringOf(jResp,"author_name")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
description.s = CkJsonObject::ckStringOf(jResp,"description")
id.s = CkJsonObject::ckStringOf(jResp,"id")
is_read_only.i = CkJsonObject::ckBoolOf(jResp,"is_read_only")
modified_at.s = CkJsonObject::ckStringOf(jResp,"modified_at")
reflow_type.s = CkJsonObject::ckStringOf(jResp,"reflow_type")
url.s = CkJsonObject::ckStringOf(jResp,"url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"widgets")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_Type = CkJsonObject::ckStringOf(jResp,"widgets[i].definition.type")
Alert_id = CkJsonObject::ckStringOf(jResp,"widgets[i].definition.alert_id")
Viz_type = CkJsonObject::ckStringOf(jResp,"widgets[i].definition.viz_type")
Live_span = CkJsonObject::ckStringOf(jResp,"widgets[i].definition.time.live_span")
Title = CkJsonObject::ckStringOf(jResp,"widgets[i].definition.title")
Title_align = CkJsonObject::ckStringOf(jResp,"widgets[i].definition.title_align")
Title_size = CkJsonObject::ckStringOf(jResp,"widgets[i].definition.title_size")
id_int = CkJsonObject::ckIntOf(jResp,"widgets[i].id")
X = CkJsonObject::ckIntOf(jResp,"widgets[i].layout.x")
Y = CkJsonObject::ckIntOf(jResp,"widgets[i].layout.y")
Width = CkJsonObject::ckIntOf(jResp,"widgets[i].layout.width")
Height = CkJsonObject::ckIntOf(jResp,"widgets[i].layout.height")
Is_column_break = CkJsonObject::ckBoolOf(jResp,"widgets[i].layout.is_column_break")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"notify_list")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"notify_list[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"restricted_roles")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"restricted_roles[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"tags[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"template_variable_presets")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"template_variable_presets[i].name")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"template_variable_presets[i].template_variables")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"template_variable_presets[i].template_variables[j].name")
value = CkJsonObject::ckStringOf(jResp,"template_variable_presets[i].template_variables[j].value")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"template_variable_presets[i].template_variables[j].values")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"template_variable_presets[i].template_variables[j].values[k]")
k = k + 1
Wend
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"template_variables")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"template_variables[i].name")
default = CkJsonObject::ckStringOf(jResp,"template_variables[i].default")
prefix = CkJsonObject::ckStringOf(jResp,"template_variables[i].prefix")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"template_variables[i].available_values")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"template_variables[i].available_values[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"template_variables[i].defaults")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"template_variables[i].defaults[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
