---
title: "Search test suites"
method: GET
path: "/api/v2/synthetics/suites/search"
tags: ["Synthetics"]
---

# Search test suites

`GET /api/v2/synthetics/suites/search`

Search for test suites.

## Query parameters

- `query` string
- `sort` string
- `facets_only` boolean
- `start` integer
- `count` integer

## Response `200`

OK

- SyntheticsSuiteSearchResponse — Synthetics suite search response
  - `data` SyntheticsSuiteSearchResponseData — Synthetics suite search response data
    - `attributes` SyntheticsSuiteSearchResponseDataAttributes — Synthetics suite search response data attributes
      - `suites` SyntheticsSuite[] — List of Synthetic suites matching the search query.
        - `message` string — Notification message associated with the suite.
        - `monitor_id` integer — The associated monitor ID.
        - `name` string, required — Name of the suite.
        - `options` SyntheticsSuiteOptions, required — Object describing the extra options for a Synthetic suite.
          - `alerting_threshold` number, double — Percentage of critical tests failure needed for a suite to fail.
        - `public_id` string — The public ID for the test.
        - `tags` string[] — Array of tags attached to the suite.
        - `tests` SyntheticsSuiteTest[], required — Array of Synthetic tests included in the suite.
          - `alerting_criticality` 'ignore' | 'critical' — Alerting criticality for each the test.
          - `public_id` string, required — The public ID of the Synthetic test included in the suite.
        - `type` 'suite', required — Type of the Synthetic suite, `suite`.
      - `total` integer — Total number of Synthetic suites matching the search query.
    - `id` string, uuid — The unique identifier of the suite search response data.
    - `type` 'suites_search' — Type for the Synthetics suites search response, `suites_search`.

## Other responses

- `400` — API error response.
- `429` — Too many requests

---

[API](https://skmtc.net/datadog/apis/api-v2.md) · [All operations](https://skmtc.net/datadog/apis/api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadog/api-v2/versions/da68bf029e4c/schema)