Back to Collection Items
#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbResponseBody;
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/dashboard/public/:token",sbResponseBody);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = http.get_LastStatus();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << http.lastHeader() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "dashboard_id": "123-abc-456",
// "dashboard_type": "custom_timeboard",
// "author": {
// "handle": "test@datadoghq.com",
// "name": "consequat irure sit"
// },
// "created_at": "2008-04-06T04:45:45.510Z",
// "global_time": {
// "live_span": "1h"
// },
// "global_time_selectable_enabled": false,
// "public_url": "fugiat esse mollit adipisicing",
// "selectable_template_vars": [
// {
// "default_value": "*",
// "name": "exampleVar",
// "prefix": "test",
// "visible_tags": [
// "selectableValue1",
// "selectableValue2"
// ]
// }
// ],
// "share_list": [
// "test@datadoghq.com",
// "test2@email.com"
// ],
// "share_type": "open",
// "token": "dolor fugiat consectetur ex"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const char *default_value = 0;
const char *name = 0;
const char *prefix = 0;
int j;
int count_j;
const char *strVal = 0;
const char *dashboard_id = jResp.stringOf("dashboard_id");
const char *dashboard_type = jResp.stringOf("dashboard_type");
const char *Handle = jResp.stringOf("author.handle");
const char *Name = jResp.stringOf("author.name");
const char *created_at = jResp.stringOf("created_at");
const char *Live_span = jResp.stringOf("global_time.live_span");
bool global_time_selectable_enabled = jResp.BoolOf("global_time_selectable_enabled");
const char *public_url = jResp.stringOf("public_url");
const char *share_type = jResp.stringOf("share_type");
const char *token = jResp.stringOf("token");
int i = 0;
int count_i = jResp.SizeOfArray("selectable_template_vars");
while (i < count_i) {
jResp.put_I(i);
default_value = jResp.stringOf("selectable_template_vars[i].default_value");
name = jResp.stringOf("selectable_template_vars[i].name");
prefix = jResp.stringOf("selectable_template_vars[i].prefix");
j = 0;
count_j = jResp.SizeOfArray("selectable_template_vars[i].visible_tags");
while (j < count_j) {
jResp.put_J(j);
strVal = jResp.stringOf("selectable_template_vars[i].visible_tags[j]");
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("share_list");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("share_list[i]");
i = i + 1;
}
}
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/dashboard/public/:token
Postman Collection Item JSON
{
"name": "Get a shared dashboard",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token",
"value": "tempor Ut sed velit"
}
]
},
"description": "Fetch an existing shared dashboard's sharing metadata associated with the specified token."
},
"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/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"author\": {\n \"handle\": \"test@datadoghq.com\",\n \"name\": \"consequat irure sit\"\n },\n \"created_at\": \"2008-04-06T04:45:45.510Z\",\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"global_time_selectable_enabled\": false,\n \"public_url\": \"fugiat esse mollit adipisicing\",\n \"selectable_template_vars\": [\n {\n \"default_value\": \"*\",\n \"name\": \"exampleVar\",\n \"prefix\": \"test\",\n \"visible_tags\": [\n \"selectableValue1\",\n \"selectableValue2\"\n ]\n }\n ],\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@email.com\"\n ],\n \"share_type\": \"open\",\n \"token\": \"dolor fugiat consectetur ex\"\n}"
},
{
"name": "Forbidden",
"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/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"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": "Shared Dashboard 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/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"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/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"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}"
}
]
}
