Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *v_type;
const wchar_t *id;
const wchar_t *v_Email;
const wchar_t *Handle;
const wchar_t *Name;
const wchar_t *created;
const wchar_t *icon;
const wchar_t *integration_id;
const wchar_t *is_favorite;
const wchar_t *is_read_only;
const wchar_t *is_shared;
const wchar_t *modified;
const wchar_t *popularity;
const wchar_t *title;
const wchar_t *url;
int j;
int count_j;
const wchar_t *strVal;
const wchar_t *total;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "dashboards": [
// {
// "type": "host_timeboard",
// "id": "<string>",
// "author": {
// "email": "<string>",
// "handle": "<string>",
// "name": "<string>"
// },
// "created": "<dateTime>",
// "icon": "<string>",
// "integration_id": "<string>",
// "is_favorite": "<boolean>",
// "is_read_only": "<boolean>",
// "is_shared": "<boolean>",
// "modified": "<dateTime>",
// "popularity": "<integer>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "title": "<string>",
// "url": "<string>"
// },
// {
// "type": "custom_screenboard",
// "id": "<string>",
// "author": {
// "email": "<string>",
// "handle": "<string>",
// "name": "<string>"
// },
// "created": "<dateTime>",
// "icon": "<string>",
// "integration_id": "<string>",
// "is_favorite": "<boolean>",
// "is_read_only": "<boolean>",
// "is_shared": "<boolean>",
// "modified": "<dateTime>",
// "popularity": "<integer>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "title": "<string>",
// "url": "<string>"
// }
// ],
// "total": "<long>"
// }
// 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.
total = CkJsonObjectW_stringOf(jResp,L"total");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"dashboards");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
v_type = CkJsonObjectW_stringOf(jResp,L"dashboards[i].type");
id = CkJsonObjectW_stringOf(jResp,L"dashboards[i].id");
v_Email = CkJsonObjectW_stringOf(jResp,L"dashboards[i].author.email");
Handle = CkJsonObjectW_stringOf(jResp,L"dashboards[i].author.handle");
Name = CkJsonObjectW_stringOf(jResp,L"dashboards[i].author.name");
created = CkJsonObjectW_stringOf(jResp,L"dashboards[i].created");
icon = CkJsonObjectW_stringOf(jResp,L"dashboards[i].icon");
integration_id = CkJsonObjectW_stringOf(jResp,L"dashboards[i].integration_id");
is_favorite = CkJsonObjectW_stringOf(jResp,L"dashboards[i].is_favorite");
is_read_only = CkJsonObjectW_stringOf(jResp,L"dashboards[i].is_read_only");
is_shared = CkJsonObjectW_stringOf(jResp,L"dashboards[i].is_shared");
modified = CkJsonObjectW_stringOf(jResp,L"dashboards[i].modified");
popularity = CkJsonObjectW_stringOf(jResp,L"dashboards[i].popularity");
title = CkJsonObjectW_stringOf(jResp,L"dashboards[i].title");
url = CkJsonObjectW_stringOf(jResp,L"dashboards[i].url");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"dashboards[i].tags");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"dashboards[i].tags[j]");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards
Postman Collection Item JSON
{
"name": "Get items of a Dashboard List",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id",
"value": "<long>"
}
]
},
"description": "Fetch the dashboard list’s dashboard definitions."
},
"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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dashboards\": [\n {\n \"type\": \"host_timeboard\",\n \"id\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"created\": \"<dateTime>\",\n \"icon\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"is_favorite\": \"<boolean>\",\n \"is_read_only\": \"<boolean>\",\n \"is_shared\": \"<boolean>\",\n \"modified\": \"<dateTime>\",\n \"popularity\": \"<integer>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"type\": \"custom_screenboard\",\n \"id\": \"<string>\",\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"created\": \"<dateTime>\",\n \"icon\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"is_favorite\": \"<boolean>\",\n \"is_read_only\": \"<boolean>\",\n \"is_shared\": \"<boolean>\",\n \"modified\": \"<dateTime>\",\n \"popularity\": \"<integer>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"total\": \"<long>\"\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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\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/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dashboard",
"lists",
"manual",
":dashboard_list_id",
"dashboards"
],
"variable": [
{
"key": "dashboard_list_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
