DAdatadog
Synthetics

Search test suites

Search for test suites.

get/api/v2/synthetics/suites/search

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v2/synthetics/suites/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: synthetics_read

Query parameters

querystring

The search query.

sortstring

The sort order for the results (e.g., name,asc or name,desc).

facets_onlyboolean

If true, return only facets instead of full test details.

startinteger

The offset from which to start returning results.

countinteger

The maximum number of results to return.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "suites": [
        {
          "message": "Notification message",
          "monitor_id": 12345678,
          "name": "Example suite name",
          "public_id": "123-abc-456",
          "tags": [
            "env:production"
          ],
          "tests": [
            {
              "alerting_criticality": "critical"
            }
          ],
          "type": "suite"
        }
      ]
    },
    "type": "suites_search"
  }
}

Changes

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