Chilkat Online Tools

phpExt / Datadog API Collection / Monitors group search

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();

$queryParams = new CkJsonObject();
$queryParams->UpdateString('query','tempor Ut sed velit');
$queryParams->UpdateInt('page',0);
$queryParams->UpdateInt('per_page',30);
$queryParams->UpdateString('sort','tempor Ut sed velit');

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

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api.app.ddog-gov.com/api/v1/monitor/groups/search',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

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

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

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

// {
//   "counts": {
//     "status": [
//       {
//         "count": 2,
//         "name": "OK"
//       }
//     ],
//     "type": [
//       {
//         "count": 2,
//         "name": "metric"
//       }
//     ]
//   },
//   "groups": [
//     {
//       "group": "*",
//       "group_tags": [
//         "*"
//       ],
//       "last_nodata_ts": 0,
//       "last_triggered_ts": 1525702966,
//       "monitor_id": 2738266,
//       "monitor_name": "[demo] Cassandra disk usage is high on {{host.name}}",
//       "status": "OK"
//     },
//     {
//       "group": "*",
//       "group_tags": [
//         "*"
//       ],
//       "last_nodata_ts": 0,
//       "last_triggered_ts": 1525703008,
//       "monitor_id": 1576648,
//       "monitor_name": "[demo] Disk usage is high on {{host.name}}",
//       "status": "OK"
//     }
//   ],
//   "metadata": {
//     "page": 0,
//     "page_count": 2,
//     "per_page": 30,
//     "total_count": 2
//   }
// }

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

$Page = $jResp->IntOf('metadata.page');
$Page_count = $jResp->IntOf('metadata.page_count');
$Per_page = $jResp->IntOf('metadata.per_page');
$Total_count = $jResp->IntOf('metadata.total_count');
$i = 0;
$count_i = $jResp->SizeOfArray('counts.status');
while ($i < $count_i) {
    $jResp->put_I($i);
    $count = $jResp->IntOf('counts.status[i].count');
    $name = $jResp->stringOf('counts.status[i].name');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('counts.type');
while ($i < $count_i) {
    $jResp->put_I($i);
    $count = $jResp->IntOf('counts.type[i].count');
    $name = $jResp->stringOf('counts.type[i].name');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('groups');
while ($i < $count_i) {
    $jResp->put_I($i);
    $group = $jResp->stringOf('groups[i].group');
    $last_nodata_ts = $jResp->IntOf('groups[i].last_nodata_ts');
    $last_triggered_ts = $jResp->IntOf('groups[i].last_triggered_ts');
    $monitor_id = $jResp->IntOf('groups[i].monitor_id');
    $monitor_name = $jResp->stringOf('groups[i].monitor_name');
    $status = $jResp->stringOf('groups[i].status');
    $j = 0;
    $count_j = $jResp->SizeOfArray('groups[i].group_tags');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('groups[i].group_tags[j]');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

Curl Command

curl -G -d "query=tempor%20Ut%20sed%20velit"
	-d "page=0"
	-d "per_page=30"
	-d "sort=tempor%20Ut%20sed%20velit"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/monitor/groups/search

Postman Collection Item JSON

{
  "name": "Monitors group search",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/monitor/groups/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "monitor",
        "groups",
        "search"
      ],
      "query": [
        {
          "key": "query",
          "value": "tempor Ut sed velit",
          "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
        },
        {
          "key": "page",
          "value": "0",
          "description": "Page to start paginating from."
        },
        {
          "key": "per_page",
          "value": "30",
          "description": "Number of monitors to return per page."
        },
        {
          "key": "sort",
          "value": "tempor Ut sed velit",
          "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
        }
      ]
    },
    "description": "Search and filter your monitor groups details."
  },
  "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/monitor/groups/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "groups",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"counts\": {\n    \"status\": [\n      {\n        \"count\": 2,\n        \"name\": \"OK\"\n      }\n    ],\n    \"type\": [\n      {\n        \"count\": 2,\n        \"name\": \"metric\"\n      }\n    ]\n  },\n  \"groups\": [\n    {\n      \"group\": \"*\",\n      \"group_tags\": [\n        \"*\"\n      ],\n      \"last_nodata_ts\": 0,\n      \"last_triggered_ts\": 1525702966,\n      \"monitor_id\": 2738266,\n      \"monitor_name\": \"[demo] Cassandra disk usage is high on {{host.name}}\",\n      \"status\": \"OK\"\n    },\n    {\n      \"group\": \"*\",\n      \"group_tags\": [\n        \"*\"\n      ],\n      \"last_nodata_ts\": 0,\n      \"last_triggered_ts\": 1525703008,\n      \"monitor_id\": 1576648,\n      \"monitor_name\": \"[demo] Disk usage is high on {{host.name}}\",\n      \"status\": \"OK\"\n    }\n  ],\n  \"metadata\": {\n    \"page\": 0,\n    \"page_count\": 2,\n    \"per_page\": 30,\n    \"total_count\": 2\n  }\n}"
    },
    {
      "name": "Bad Request",
      "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/monitor/groups/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "groups",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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/monitor/groups/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "groups",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "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/monitor/groups/search?query=tempor Ut sed velit&page=0&per_page=30&sort=tempor Ut sed velit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "monitor",
            "groups",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "tempor Ut sed velit",
              "description": "After entering a search query in your [Manage Monitor page][1] use the query parameter value in the\nURL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2]\npage to learn more.\n\nThe query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`.\n\n[1]: https://app.datadoghq.com/monitors/manage\n[2]: /monitors/manage/#find-the-monitors"
            },
            {
              "key": "page",
              "value": "0",
              "description": "Page to start paginating from."
            },
            {
              "key": "per_page",
              "value": "30",
              "description": "Number of monitors to return per page."
            },
            {
              "key": "sort",
              "value": "tempor Ut sed velit",
              "description": "String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields:\n\n* `name`\n* `status`\n* `tags`"
            }
          ]
        }
      },
      "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}"
    }
  ]
}