Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *v_Type;
const char *Alert_id;
const char *Viz_type;
const char *Live_span;
const char *Title;
const char *Title_align;
const char *Title_size;
int id_int;
int X;
int Y;
int Width;
int Height;
BOOL Is_column_break;
const char *strVal;
const char *name;
int j;
int count_j;
const char *value;
int k;
int count_k;
const char *default;
const char *prefix;
const char *title;
const char *layout_type;
const char *author_handle;
const char *author_name;
const char *created_at;
const char *description;
const char *id;
BOOL is_read_only;
const char *modified_at;
const char *reflow_type;
const char *url;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "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"
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"title","");
CkJsonObject_UpdateString(json,"layout_type","ordered");
CkJsonObject_UpdateString(json,"widgets[0].definition.type","alert_graph");
CkJsonObject_UpdateString(json,"widgets[0].definition.alert_id","");
CkJsonObject_UpdateString(json,"widgets[0].definition.viz_type","timeseries");
CkJsonObject_UpdateString(json,"widgets[0].definition.time.live_span","5m");
CkJsonObject_UpdateString(json,"widgets[0].definition.title","nisi et cupidatat sunt");
CkJsonObject_UpdateString(json,"widgets[0].definition.title_align","right");
CkJsonObject_UpdateString(json,"widgets[0].definition.title_size","officia anim occaecat aliq");
CkJsonObject_UpdateInt(json,"widgets[0].id",45068649);
CkJsonObject_UpdateInt(json,"widgets[0].layout.x",0);
CkJsonObject_UpdateInt(json,"widgets[0].layout.y",0);
CkJsonObject_UpdateInt(json,"widgets[0].layout.width",0);
CkJsonObject_UpdateInt(json,"widgets[0].layout.height",0);
CkJsonObject_UpdateBool(json,"widgets[0].layout.is_column_break",TRUE);
CkJsonObject_UpdateString(json,"widgets[1].definition.type","alert_graph");
CkJsonObject_UpdateString(json,"widgets[1].definition.alert_id","");
CkJsonObject_UpdateString(json,"widgets[1].definition.viz_type","timeseries");
CkJsonObject_UpdateString(json,"widgets[1].definition.time.live_span","5m");
CkJsonObject_UpdateString(json,"widgets[1].definition.title","laborum dolor cillum ad");
CkJsonObject_UpdateString(json,"widgets[1].definition.title_align","center");
CkJsonObject_UpdateString(json,"widgets[1].definition.title_size","et");
CkJsonObject_UpdateInt(json,"widgets[1].id",-40196020);
CkJsonObject_UpdateInt(json,"widgets[1].layout.x",0);
CkJsonObject_UpdateInt(json,"widgets[1].layout.y",0);
CkJsonObject_UpdateInt(json,"widgets[1].layout.width",0);
CkJsonObject_UpdateInt(json,"widgets[1].layout.height",0);
CkJsonObject_UpdateBool(json,"widgets[1].layout.is_column_break",FALSE);
CkJsonObject_UpdateString(json,"author_handle","test@datadoghq.com");
CkJsonObject_UpdateString(json,"author_name","John Doe");
CkJsonObject_UpdateString(json,"created_at","2017-08-17T07:10:36.438Z");
CkJsonObject_UpdateString(json,"description","eiusmod do est velit enim");
CkJsonObject_UpdateString(json,"id","123-abc-456");
CkJsonObject_UpdateBool(json,"is_read_only",FALSE);
CkJsonObject_UpdateString(json,"modified_at","1996-07-08T08:32:43.112Z");
CkJsonObject_UpdateString(json,"notify_list[0]","commodo voluptate eu");
CkJsonObject_UpdateString(json,"notify_list[1]","consectetur amet");
CkJsonObject_UpdateString(json,"reflow_type","fixed");
CkJsonObject_UpdateString(json,"restricted_roles[0]","id cupidatat");
CkJsonObject_UpdateString(json,"restricted_roles[1]","quis ullamco");
CkJsonObject_UpdateString(json,"tags[0]","quis qui mollit ex");
CkJsonObject_UpdateString(json,"tags[1]","ullamco enim cupidatat");
CkJsonObject_UpdateString(json,"template_variable_presets[0].name","Lorem ex enim");
CkJsonObject_UpdateString(json,"template_variable_presets[0].template_variables[0].name","sed ");
CkJsonObject_UpdateString(json,"template_variable_presets[0].template_variables[0].value","quis eu");
CkJsonObject_UpdateString(json,"template_variable_presets[0].template_variables[0].values[0]","in");
CkJsonObject_UpdateString(json,"template_variable_presets[0].template_variables[1].name","non");
CkJsonObject_UpdateString(json,"template_variable_presets[0].template_variables[1].value","ea dolore esse elit Lorem");
CkJsonObject_UpdateString(json,"template_variable_presets[0].template_variables[1].values[0]","sed voluptate nulla");
CkJsonObject_UpdateString(json,"template_variable_presets[1].name","est ");
CkJsonObject_UpdateString(json,"template_variable_presets[1].template_variables[0].name","ullamco sint");
CkJsonObject_UpdateString(json,"template_variable_presets[1].template_variables[0].value","ad ex irure");
CkJsonObject_UpdateString(json,"template_variable_presets[1].template_variables[0].values[0]","Duis elit dolor");
CkJsonObject_UpdateString(json,"template_variable_presets[1].template_variables[1].name","proident adipisicing culpa cons");
CkJsonObject_UpdateString(json,"template_variable_presets[1].template_variables[1].value","occaecat");
CkJsonObject_UpdateString(json,"template_variable_presets[1].template_variables[1].values[0]","esse fugiat");
CkJsonObject_UpdateString(json,"template_variables[0].name","host1");
CkJsonObject_UpdateString(json,"template_variables[0].available_values[0]","my-host");
CkJsonObject_UpdateString(json,"template_variables[0].available_values[1]","host1");
CkJsonObject_UpdateString(json,"template_variables[0].available_values[2]","host2");
CkJsonObject_UpdateString(json,"template_variables[0].default","my-host");
CkJsonObject_UpdateString(json,"template_variables[0].defaults[0]","my-host-1");
CkJsonObject_UpdateString(json,"template_variables[0].defaults[1]","my-host-2");
CkJsonObject_UpdateString(json,"template_variables[0].prefix","host");
CkJsonObject_UpdateString(json,"template_variables[1].name","host1");
CkJsonObject_UpdateString(json,"template_variables[1].available_values[0]","my-host");
CkJsonObject_UpdateString(json,"template_variables[1].available_values[1]","host1");
CkJsonObject_UpdateString(json,"template_variables[1].available_values[2]","host2");
CkJsonObject_UpdateString(json,"template_variables[1].default","my-host");
CkJsonObject_UpdateString(json,"template_variables[1].defaults[0]","my-host-1");
CkJsonObject_UpdateString(json,"template_variables[1].defaults[1]","my-host-2");
CkJsonObject_UpdateString(json,"template_variables[1].prefix","host");
CkJsonObject_UpdateString(json,"url","/dashboard/123-abc-456/example-dashboard-title");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_PostJson3(http,"https://api.app.ddog-gov.com/api/v1/dashboard","application/json",json);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
title = CkJsonObject_stringOf(jResp,"title");
layout_type = CkJsonObject_stringOf(jResp,"layout_type");
author_handle = CkJsonObject_stringOf(jResp,"author_handle");
author_name = CkJsonObject_stringOf(jResp,"author_name");
created_at = CkJsonObject_stringOf(jResp,"created_at");
description = CkJsonObject_stringOf(jResp,"description");
id = CkJsonObject_stringOf(jResp,"id");
is_read_only = CkJsonObject_BoolOf(jResp,"is_read_only");
modified_at = CkJsonObject_stringOf(jResp,"modified_at");
reflow_type = CkJsonObject_stringOf(jResp,"reflow_type");
url = CkJsonObject_stringOf(jResp,"url");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"widgets");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
v_Type = CkJsonObject_stringOf(jResp,"widgets[i].definition.type");
Alert_id = CkJsonObject_stringOf(jResp,"widgets[i].definition.alert_id");
Viz_type = CkJsonObject_stringOf(jResp,"widgets[i].definition.viz_type");
Live_span = CkJsonObject_stringOf(jResp,"widgets[i].definition.time.live_span");
Title = CkJsonObject_stringOf(jResp,"widgets[i].definition.title");
Title_align = CkJsonObject_stringOf(jResp,"widgets[i].definition.title_align");
Title_size = CkJsonObject_stringOf(jResp,"widgets[i].definition.title_size");
id_int = CkJsonObject_IntOf(jResp,"widgets[i].id");
X = CkJsonObject_IntOf(jResp,"widgets[i].layout.x");
Y = CkJsonObject_IntOf(jResp,"widgets[i].layout.y");
Width = CkJsonObject_IntOf(jResp,"widgets[i].layout.width");
Height = CkJsonObject_IntOf(jResp,"widgets[i].layout.height");
Is_column_break = CkJsonObject_BoolOf(jResp,"widgets[i].layout.is_column_break");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"notify_list");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"notify_list[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"restricted_roles");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"restricted_roles[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"tags");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"tags[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"template_variable_presets");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
name = CkJsonObject_stringOf(jResp,"template_variable_presets[i].name");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"template_variable_presets[i].template_variables");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
name = CkJsonObject_stringOf(jResp,"template_variable_presets[i].template_variables[j].name");
value = CkJsonObject_stringOf(jResp,"template_variable_presets[i].template_variables[j].value");
k = 0;
count_k = CkJsonObject_SizeOfArray(jResp,"template_variable_presets[i].template_variables[j].values");
while (k < count_k) {
CkJsonObject_putK(jResp,k);
strVal = CkJsonObject_stringOf(jResp,"template_variable_presets[i].template_variables[j].values[k]");
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"template_variables");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
name = CkJsonObject_stringOf(jResp,"template_variables[i].name");
default = CkJsonObject_stringOf(jResp,"template_variables[i].default");
prefix = CkJsonObject_stringOf(jResp,"template_variables[i].prefix");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"template_variables[i].available_values");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
strVal = CkJsonObject_stringOf(jResp,"template_variables[i].available_values[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"template_variables[i].defaults");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
strVal = CkJsonObject_stringOf(jResp,"template_variables[i].defaults[j]");
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"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"
}'
https://api.app.ddog-gov.com/api/v1/dashboard
Postman Collection Item JSON
{
"name": "Create a new dashboard",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
},
"description": "Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended.\nRefer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"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": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard"
]
}
},
"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}"
}
]
}
