Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v1/dashboard/:dashboard_id" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set title [CkJsonObject_stringOf $jResp "title"]
set layout_type [CkJsonObject_stringOf $jResp "layout_type"]
set author_handle [CkJsonObject_stringOf $jResp "author_handle"]
set author_name [CkJsonObject_stringOf $jResp "author_name"]
set created_at [CkJsonObject_stringOf $jResp "created_at"]
set description [CkJsonObject_stringOf $jResp "description"]
set id [CkJsonObject_stringOf $jResp "id"]
set is_read_only [CkJsonObject_BoolOf $jResp "is_read_only"]
set modified_at [CkJsonObject_stringOf $jResp "modified_at"]
set reflow_type [CkJsonObject_stringOf $jResp "reflow_type"]
set url [CkJsonObject_stringOf $jResp "url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "widgets"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set v_Type [CkJsonObject_stringOf $jResp "widgets[i].definition.type"]
set Alert_id [CkJsonObject_stringOf $jResp "widgets[i].definition.alert_id"]
set Viz_type [CkJsonObject_stringOf $jResp "widgets[i].definition.viz_type"]
set Live_span [CkJsonObject_stringOf $jResp "widgets[i].definition.time.live_span"]
set Title [CkJsonObject_stringOf $jResp "widgets[i].definition.title"]
set Title_align [CkJsonObject_stringOf $jResp "widgets[i].definition.title_align"]
set Title_size [CkJsonObject_stringOf $jResp "widgets[i].definition.title_size"]
set id_int [CkJsonObject_IntOf $jResp "widgets[i].id"]
set X [CkJsonObject_IntOf $jResp "widgets[i].layout.x"]
set Y [CkJsonObject_IntOf $jResp "widgets[i].layout.y"]
set Width [CkJsonObject_IntOf $jResp "widgets[i].layout.width"]
set Height [CkJsonObject_IntOf $jResp "widgets[i].layout.height"]
set Is_column_break [CkJsonObject_BoolOf $jResp "widgets[i].layout.is_column_break"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "notify_list"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "notify_list[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "restricted_roles"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "restricted_roles[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "tags"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "tags[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "template_variable_presets"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "template_variable_presets[i].name"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "template_variable_presets[i].template_variables"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set name [CkJsonObject_stringOf $jResp "template_variable_presets[i].template_variables[j].name"]
set value [CkJsonObject_stringOf $jResp "template_variable_presets[i].template_variables[j].value"]
set k 0
set count_k [CkJsonObject_SizeOfArray $jResp "template_variable_presets[i].template_variables[j].values"]
while {$k < $count_k} {
CkJsonObject_put_K $jResp $k
set strVal [CkJsonObject_stringOf $jResp "template_variable_presets[i].template_variables[j].values[k]"]
set k [expr $k + 1]
}
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "template_variables"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "template_variables[i].name"]
set default [CkJsonObject_stringOf $jResp "template_variables[i].default"]
set prefix [CkJsonObject_stringOf $jResp "template_variables[i].prefix"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "template_variables[i].available_values"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "template_variables[i].available_values[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "template_variables[i].defaults"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "template_variables[i].defaults[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
