v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Scorecards

List all rule outcomes

Fetches all rule outcomes.

get/api/v2/scorecard/outcomes

Query parameters

page[size]integer

Example:10

Size for a given page. The maximum allowed value is 100.

page[offset]integer

Specific offset to use as the beginning of the returned page.

includestring

Example:rule

Include related rule details in the response.

fields[outcome]string

Example:state, service_name

Return only specified values in the outcome attributes.

fields[rule]string

Example:name

Return only specified values in the included rule details.

filter[outcome][service_name]string

Example:web-store

Filter outcomes on a specific service name.

filter[outcome][state]string

Example:fail

Filter outcomes by a specific state.

filter[rule][enabled]boolean

Example:true

Filter outcomes based on whether a rule is enabled or disabled.

filter[rule][id]string

Example:f4485c79-0762-449c-96cf-c31e54a659f6

Filter outcomes based on rule ID.

filter[rule][name]string

Example:SLOs Defined

Filter outcomes based on rule name.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "remarks": "See: <a href=\"https://app.datadoghq.com/services\">Services</a>",
        "service_name": "my-service",
        "state": "pass"
      },
      "relationships": {
        "rule": {
          "data": {
            "id": "q8MQxk8TCqrHnWkx",
            "type": "rule"
          }
        }
      },
      "type": "outcome"
    }
  ],
  "included": [
    {
      "attributes": {
        "name": "Team Defined",
        "scorecard_name": "Observability Best Practices"
      },
      "id": "q8MQxk8TCqrHnWkx",
      "type": "rule"
    }
  ],
  "links": {
    "next": "/api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100"
  }
}