Chilkat Online Tools

delphiAx / Datadog API Collection / Get items of a Dashboard List

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_type: WideString;
id: WideString;
v_Email: WideString;
Handle: WideString;
Name: WideString;
created: WideString;
icon: WideString;
integration_id: WideString;
is_favorite: WideString;
is_read_only: WideString;
is_shared: WideString;
modified: WideString;
popularity: WideString;
title: WideString;
url: WideString;
j: Integer;
count_j: Integer;
strVal: WideString;
total: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

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

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

total := jResp.StringOf('total');
i := 0;
count_i := jResp.SizeOfArray('dashboards');
while i < count_i do
  begin
    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 do
      begin
        jResp.J := j;
        strVal := jResp.StringOf('dashboards[i].tags[j]');
        j := j + 1;
      end;

    i := i + 1;
  end;

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