Chilkat Online Tools

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

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

$http = new CkHttp();

$http->SetRequestHeader('Accept','application/json');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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) {
    $jResp->put_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->put_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}"
    }
  ]
}