DAdatadog
Monitors

Monitors search

Search and filter your monitors details.

get/api/v1/monitor/search

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/monitor/search
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: monitors_read

Query parameters

querystring

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 page to learn more.

The query can contain any number of space-separated monitor attributes, for instance query="type:metric 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": {
    "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,
      "quality_issues": [
        "broken_at_handle",
        "noisy_monitor"
      ],
      "scopes": [
        "!availability-zone:us-east-1c",
        "name:cassandra"
      ],
      "status": "No Data",
      "tags": [
        "service:cassandra"
      ],
      "type": "query alert"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.