Monitors search
GET {{baseUrl}}/api/v1/monitor/search
Search and filter your monitors details.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
query | string | After entering a search query in your Manage Monitor page use the query parameter value in the | |
URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] | |||
page to learn more. |
The query can contain any number of space-separated monitor attributes, for instance query="type:metric status:alert"
.
[2]: /monitors/manage/#find-the-monitors |
| page
| number | | Page to start paginating from. |
| per_page
| number | | Number of monitors to return per page. |
| sort
| string | | 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
|
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"counts":{"muted":[{"count":3,"name":false},{"count":3,"name":true}],"status":[{"count":4,"name":"No Data"},{"count":2,"name":"OK"}],"tag":[{"count":6,"name":"service:cassandra"}],"type":[{"count":6,"name":"metric"}]},"metadata":{"page":0,"page_count":6,"per_page":30,"total_count":6},"monitors":[{"classification":"metric","creator":{"handle":"john@datadoghq.com","name":"John Doe"},"id":2699850,"last_triggered_ts":null,"metrics":["system.cpu.user"],"name":"Cassandra CPU is high on {{host.name}} in {{availability-zone.name}}","notifications":[{"handle":"jane@datadoghq.com","name":"Jane Doe"}],"org_id":1234,"scopes":["!availability-zone:us-east-1c","name:cassandra"],"status":"No Data","tags":["service:cassandra"],"type":"query alert"}]}