Chilkat Online Tools

phpExt / Datadog API Collection / Get active downtimes for a monitor

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// 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/monitor/:monitor_id/downtime_matches',$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)

// {
//   "data": [
//     {
//       "attributes": {
//         "end": "<dateTime>",
//         "groups": [
//           "<string>",
//           "<string>"
//         ],
//         "scope": "<string>",
//         "start": "<dateTime>"
//       },
//       "id": "<string>",
//       "type": "downtime_match"
//     },
//     {
//       "attributes": {
//         "end": "<dateTime>",
//         "groups": [
//           "<string>",
//           "<string>"
//         ],
//         "scope": "<string>",
//         "start": "<dateTime>"
//       },
//       "id": "<string>",
//       "type": "downtime_match"
//     }
//   ],
//   "meta": {
//     "page": {
//       "total_filtered_count": "<long>"
//     }
//   }
// }

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

$Total_filtered_count = $jResp->stringOf('meta.page.total_filtered_count');
$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
    $jResp->put_I($i);
    $v_End = $jResp->stringOf('data[i].attributes.end');
    $Scope = $jResp->stringOf('data[i].attributes.scope');
    $Start = $jResp->stringOf('data[i].attributes.start');
    $id = $jResp->stringOf('data[i].id');
    $v_type = $jResp->stringOf('data[i].type');
    $j = 0;
    $count_j = $jResp->SizeOfArray('data[i].attributes.groups');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('data[i].attributes.groups[j]');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/monitor/:monitor_id/downtime_matches

Postman Collection Item JSON

{
  "name": "Get active downtimes for a monitor",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/monitor/:monitor_id/downtime_matches",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "monitor",
        ":monitor_id",
        "downtime_matches"
      ],
      "variable": [
        {
          "key": "monitor_id",
          "value": "<long>"
        }
      ]
    },
    "description": "Get all active downtimes for the specified monitor."
  },
  "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/monitor/:monitor_id/downtime_matches",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "monitor",
            ":monitor_id",
            "downtime_matches"
          ],
          "variable": [
            {
              "key": "monitor_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"end\": \"<dateTime>\",\n        \"groups\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"scope\": \"<string>\",\n        \"start\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"downtime_match\"\n    },\n    {\n      \"attributes\": {\n        \"end\": \"<dateTime>\",\n        \"groups\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"scope\": \"<string>\",\n        \"start\": \"<dateTime>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"downtime_match\"\n    }\n  ],\n  \"meta\": {\n    \"page\": {\n      \"total_filtered_count\": \"<long>\"\n    }\n  }\n}"
    },
    {
      "name": "Monitor Not Found error",
      "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/monitor/:monitor_id/downtime_matches",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "monitor",
            ":monitor_id",
            "downtime_matches"
          ],
          "variable": [
            {
              "key": "monitor_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/monitor/:monitor_id/downtime_matches",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "monitor",
            ":monitor_id",
            "downtime_matches"
          ],
          "variable": [
            {
              "key": "monitor_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}"
    }
  ]
}