Chilkat Online Tools

delphiDll / Datadog API Collection / Get all dashboard lists

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
name: PWideChar;
v_Email: PWideChar;
Handle: PWideChar;
Name: PWideChar;
created: PWideChar;
dashboard_count: Integer;
id: Integer;
is_favorite: Boolean;
modified: PWideChar;
v_type: PWideChar;
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 := CkHttp_Create();

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.app.ddog-gov.com/api/v1/dashboard/lists/manual',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

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

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

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "dashboard_lists": [
//     {
//       "name": "My Dashboard",
//       "author": {
//         "email": "reprehenderit nostrud",
//         "handle": "qui officia tempor",
//         "name": "ex"
//       },
//       "created": "1963-08-11T12:15:03.407Z",
//       "dashboard_count": -63891965,
//       "id": -37288260,
//       "is_favorite": true,
//       "modified": "1993-02-16T23:18:05.785Z",
//       "type": "manual_dashboard_list"
//     },
//     {
//       "name": "My Dashboard",
//       "author": {
//         "email": "Duis reprehenderit est",
//         "handle": "consequat qui esse incididunt",
//         "name": "qui non ad"
//       },
//       "created": "2012-05-31T22:35:18.125Z",
//       "dashboard_count": -45121707,
//       "id": -45358157,
//       "is_favorite": false,
//       "modified": "1966-04-15T02:24:29.676Z",
//       "type": "manual_dashboard_list"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'dashboard_lists');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    name := CkJsonObject__stringOf(jResp,'dashboard_lists[i].name');
    v_Email := CkJsonObject__stringOf(jResp,'dashboard_lists[i].author.email');
    Handle := CkJsonObject__stringOf(jResp,'dashboard_lists[i].author.handle');
    Name := CkJsonObject__stringOf(jResp,'dashboard_lists[i].author.name');
    created := CkJsonObject__stringOf(jResp,'dashboard_lists[i].created');
    dashboard_count := CkJsonObject_IntOf(jResp,'dashboard_lists[i].dashboard_count');
    id := CkJsonObject_IntOf(jResp,'dashboard_lists[i].id');
    is_favorite := CkJsonObject_BoolOf(jResp,'dashboard_lists[i].is_favorite');
    modified := CkJsonObject__stringOf(jResp,'dashboard_lists[i].modified');
    v_type := CkJsonObject__stringOf(jResp,'dashboard_lists[i].type');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/dashboard/lists/manual

Postman Collection Item JSON

{
  "name": "Get all dashboard lists",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/dashboard/lists/manual",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "dashboard",
        "lists",
        "manual"
      ]
    },
    "description": "Fetch all of your existing dashboard list 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/v1/dashboard/lists/manual",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "lists",
            "manual"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"dashboard_lists\": [\n    {\n      \"name\": \"My Dashboard\",\n      \"author\": {\n        \"email\": \"reprehenderit nostrud\",\n        \"handle\": \"qui officia tempor\",\n        \"name\": \"ex\"\n      },\n      \"created\": \"1963-08-11T12:15:03.407Z\",\n      \"dashboard_count\": -63891965,\n      \"id\": -37288260,\n      \"is_favorite\": true,\n      \"modified\": \"1993-02-16T23:18:05.785Z\",\n      \"type\": \"manual_dashboard_list\"\n    },\n    {\n      \"name\": \"My Dashboard\",\n      \"author\": {\n        \"email\": \"Duis reprehenderit est\",\n        \"handle\": \"consequat qui esse incididunt\",\n        \"name\": \"qui non ad\"\n      },\n      \"created\": \"2012-05-31T22:35:18.125Z\",\n      \"dashboard_count\": -45121707,\n      \"id\": -45358157,\n      \"is_favorite\": false,\n      \"modified\": \"1966-04-15T02:24:29.676Z\",\n      \"type\": \"manual_dashboard_list\"\n    }\n  ]\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/lists/manual",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "lists",
            "manual"
          ]
        }
      },
      "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": "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/lists/manual",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "dashboard",
            "lists",
            "manual"
          ]
        }
      },
      "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}"
    }
  ]
}