Chilkat Online Tools

C# / Datadog API Collection / Get items of a Dashboard List

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.SetRequestHeader("Accept","application/json");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    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

string v_type;
string id;
string v_Email;
string Handle;
string Name;
string created;
string icon;
string integration_id;
string is_favorite;
string is_read_only;
string is_shared;
string modified;
string popularity;
string title;
string url;
int j;
int count_j;
string strVal;

string total = jResp.StringOf("total");
int i = 0;
int count_i = jResp.SizeOfArray("dashboards");
while (i < count_i) {
    jResp.I = i;
    v_type = jResp.StringOf("dashboards[i].type");
    id = jResp.StringOf("dashboards[i].id");
    v_Email = jResp.StringOf("dashboards[i].author.email");
    Handle = jResp.StringOf("dashboards[i].author.handle");
    Name = jResp.StringOf("dashboards[i].author.name");
    created = jResp.StringOf("dashboards[i].created");
    icon = jResp.StringOf("dashboards[i].icon");
    integration_id = jResp.StringOf("dashboards[i].integration_id");
    is_favorite = jResp.StringOf("dashboards[i].is_favorite");
    is_read_only = jResp.StringOf("dashboards[i].is_read_only");
    is_shared = jResp.StringOf("dashboards[i].is_shared");
    modified = jResp.StringOf("dashboards[i].modified");
    popularity = jResp.StringOf("dashboards[i].popularity");
    title = jResp.StringOf("dashboards[i].title");
    url = jResp.StringOf("dashboards[i].url");
    j = 0;
    count_j = jResp.SizeOfArray("dashboards[i].tags");
    while (j < count_j) {
        jResp.J = j;
        strVal = jResp.StringOf("dashboards[i].tags[j]");
        j = j + 1;
    }

    i = i + 1;
}

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}"
    }
  ]
}