--- title: モニター検索 description: モニターの詳細を検索およびフィルタリングします。 breadcrumbs: ドキュメント > API > モニター検索 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # モニター検索 ## v1 (latest) | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/monitor/search | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/monitor/search | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/monitor/search | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/monitor/search | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/monitor/search | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/monitor/search | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v1/monitor/search | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/monitor/search | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/monitor/search | ### Overview モニターの詳細を検索およびフィルタリングします。 This endpoint requires the `monitors_read` permission. OAuth apps require the `monitors_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ja/api/latest/scopes.md#monitors) to access this endpoint. ### Arguments #### Query Strings | Field | Type | Description | | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | query | string | After entering a search query in your [Manage Monitor page](https://app.datadoghq.com/monitors/manage) use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation](https://dnd37xeb23o8n.cloudfront.net/monitors/manage.md#find-the-monitors) page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query="type:metric status:alert"`. | | page | integer | Page to start paginating from. Default: `0`. | | per_page | integer | Number of monitors to return per page. Default: `30`. | | 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` | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} The response from a monitor search. | Parent field | Field | Type | Description | | ------------- | ----------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | counts | object | The counts of monitors per different criteria. Read-only. | | counts | muted | [object] | Search facets. | | muted | count | int64 | The number of found monitors with the listed value. Read-only. | | muted | name | any | The facet value. Read-only. | | counts | status | [object] | Search facets. | | status | count | int64 | The number of found monitors with the listed value. Read-only. | | status | name | any | The facet value. Read-only. | | counts | tag | [object] | Search facets. | | tag | count | int64 | The number of found monitors with the listed value. Read-only. | | tag | name | any | The facet value. Read-only. | | counts | type | [object] | Search facets. | | type | count | int64 | The number of found monitors with the listed value. Read-only. | | type | name | any | The facet value. Read-only. | | | metadata | object | Metadata about the response. | | metadata | page | int64 | The page to start paginating from. Read-only. | | metadata | page_count | int64 | The number of pages. Read-only. | | metadata | per_page | int64 | The number of monitors to return per page. Read-only. | | metadata | total_count | int64 | The total number of monitors. Read-only. | | | monitors | [object] | The list of found monitors. Read-only. | | monitors | classification | string | Classification of the monitor. Read-only. | | monitors | creator | object | Object describing the creator of the shared element. Read-only. | | creator | email | string | Email of the creator. | | creator | handle | string | Handle of the creator. | | creator | name | string | Name of the creator. | | monitors | id | int64 | ID of the monitor. Read-only. | | monitors | last_triggered_ts | int64 | Latest timestamp the monitor triggered. Read-only. | | monitors | metrics | [string] | Metrics used by the monitor. Read-only. | | monitors | name | string | The monitor name. Read-only. | | monitors | notifications | [object] | The notification triggered by the monitor. Read-only. | | notifications | handle | string | The email address that received the notification. Read-only. | | notifications | name | string | The username receiving the notification Read-only. | | monitors | org_id | int64 | The ID of the organization. Read-only. | | monitors | quality_issues | [string] | Quality issues detected with the monitor. Read-only. | | monitors | query | string | The monitor query. | | monitors | scopes | [string] | The scope(s) to which the downtime applies, for example `host:app2`. Provide multiple scopes as a comma-separated list, for example `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (that is `env:dev AND env:prod`), NOT any of them. | | monitors | status | enum | The different states your monitor can be in. Read-only. Allowed enum values: `Alert`, `Ignored`, `No Data`, `OK`, `Skipped`, `Unknown`, `Warn`. | | monitors | tags | [string] | Tags associated with the monitor. Read-only. | | monitors | type | enum | The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options.md) docs. Allowed enum values: `composite`, `event alert`, `log alert`, `metric alert`, `process alert`, `query alert`, `rum alert`, `service check`, `synthetics alert`, `trace-analytics alert`, `slo alert`, `event-v2 alert`, `audit alert`, `ci-pipelines alert`, `ci-tests alert`, `error-tracking alert`, `database-monitoring alert`, `network-performance alert`, `cost alert`, `data-quality alert`, `network-path alert`, `data-jobs alert`, `llm-observability alert`. | {% /tab %} {% tab label="Example" %} ```json { "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" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v1/monitor/search" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Monitors search returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewMonitorsApi(apiClient) resp, r, err := api.SearchMonitors(ctx, *datadogV1.NewSearchMonitorsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MonitorsApi.SearchMonitors`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MonitorsApi.SearchMonitors`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Monitors search returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.MonitorsApi; import com.datadog.api.client.v1.model.MonitorSearchResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); MonitorsApi apiInstance = new MonitorsApi(defaultClient); try { MonitorSearchResponse result = apiInstance.searchMonitors(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MonitorsApi#searchMonitors"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Monitors search returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.monitors_api import MonitorsApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = MonitorsApi(api_client) response = api_instance.search_monitors() print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Monitors search returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V1::MonitorsAPI.new p api_instance.search_monitors() ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Monitors search returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_monitors::MonitorsAPI; use datadog_api_client::datadogV1::api_monitors::SearchMonitorsOptionalParams; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = MonitorsAPI::with_config(configuration); let resp = api .search_monitors(SearchMonitorsOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Monitors search returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v1.MonitorsApi(configuration); apiInstance .searchMonitors() .then((data: v1.MonitorSearchResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% tab label="Python [legacy]" %} ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) # Search monitors api.Monitor.search() # Examples of possible query parameters: # api.Monitor.search(query="id:7100311") # api.Monitor.search(query="title:foo metric:system.core.idle status:Alert") ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ``` {% /tab %} {% tab label="Ruby [legacy]" %} ```ruby require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) # Search monitors dog.search_monitors # Examples of possible query parameters: # dog.search_monitors(query="id:7100311") # dog.search_monitors(query="title:foo metric:system.core.idle status:Alert") ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ``` {% /tab %} {% /tabs %}