Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Monitors

Monitors group search

Search and filter your monitor groups details.

get/api/v1/monitor/groups/search

Query parameters

querystring

After entering a search query on the Triggered Monitors page, use the query parameter value in the URL of the page as a value for this parameter. For more information, see the Manage Monitors documentation.

The query can contain any number of space-separated monitor attributes, for instance: query="type:metric group_status:alert".

pageinteger

Page to start paginating from.

per_pageinteger

Number of monitors to return per page.

sortstring

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:

  • name
  • status
  • tags

Response

OK

Example response

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