Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED
This product is not supported for your selected Datadog site. ().

List all scores

copy Copy pageCopied

GET https://api.ap1.datadoghq.com/api/v2/scorecard/scores/{aggregation}https://api.ap2.datadoghq.com/api/v2/scorecard/scores/{aggregation}https://api.datadoghq.eu/api/v2/scorecard/scores/{aggregation}https://api.ddog-gov.com/api/v2/scorecard/scores/{aggregation}https://api.us2.ddog-gov.com/api/v2/scorecard/scores/{aggregation}https://api.datadoghq.com/api/v2/scorecard/scores/{aggregation}https://api.us3.datadoghq.com/api/v2/scorecard/scores/{aggregation}https://api.us5.datadoghq.com/api/v2/scorecard/scores/{aggregation}

Overview

Returns a list of scorecard scores for each aggregation type, with score breakdowns.

OAuth apps require the apm_service_catalog_read authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

aggregation [required]

string

The type of scores being requested.

Query Strings

Name

Type

Description

filter[rule][id]

string

Filter scores by rule ID(s), comma-separated.

filter[rule][name]

string

Filter scores by rule name.

filter[rule][level]

string

Filter scores by rule level(s), comma-separated.

filter[rule][scorecard_id]

string

Filter scores by scorecard ID(s), comma-separated.

filter[rule][is_custom]

boolean

Filter scores to show only custom rules.

filter[rule][is_enabled]

boolean

Filter scores to show only enabled rules.

sort

string

Sort scores by field. Use a hyphen prefix for descending order. Options: score, numerator, denominator, total_pass, total_fail, total_skip, total_no_data.

page[offset]

integer

Offset for pagination.

page[limit]

integer

Number of scores to return. Max is 1000.

Response

OK

A list of scorecard scores for a given aggregation type.

Expand All

Field

Type

Description

data

[object]

Array of score objects.

attributes

object

Attributes of a scorecard score.

aggregation

enum

Dimension to group scores by. Allowed enum values: by-entity,by-rule,by-scorecard,by-team,by-kind

denominator

int64

The denominator used to compute the score ratio.

level

int64

The maturity level of the associated rule.

numerator

int64

The numerator used to compute the score ratio.

score

double

The computed score ratio (numerator/denominator), from 0 to 1.

total_entities

int64

The total number of entities evaluated.

total_fail

int64

The number of rules that failed.

total_no_data

int64

The number of rules with no data.

total_pass

int64

The number of rules that passed.

total_skip

int64

The number of rules that were skipped.

id [required]

string

The ID of the entity or resource being scored.

relationships

object

Relationships for a scorecard score, depending on the aggregation type.

entity

object

A relationship item for a score.

data

object

A relationship data object for a score.

id [required]

string

The ID of the related resource.

type [required]

string

The type of the related resource.

rule

object

A relationship item for a score.

data

object

A relationship data object for a score.

id [required]

string

The ID of the related resource.

type [required]

string

The type of the related resource.

scorecard

object

A relationship item for a score.

data

object

A relationship data object for a score.

id [required]

string

The ID of the related resource.

type [required]

string

The type of the related resource.

service

object

A relationship item for a score.

data

object

A relationship data object for a score.

id [required]

string

The ID of the related resource.

type [required]

string

The type of the related resource.

team

object

A relationship item for a score.

data

object

A relationship data object for a score.

id [required]

string

The ID of the related resource.

type [required]

string

The type of the related resource.

type [required]

enum

The JSON:API resource type. Allowed enum values: score

default: score

links

object

Links attributes.

next

string

Link for the next set of rules.

meta

object

Pagination metadata for scores.

count

int64

The number of results returned in this page.

limit

int64

The page limit.

offset

int64

The page offset.

total

int64

The total number of results.

{
  "data": [
    {
      "attributes": {
        "aggregation": "by-entity",
        "denominator": "integer",
        "level": "integer",
        "numerator": "integer",
        "score": "number",
        "total_entities": "integer",
        "total_fail": "integer",
        "total_no_data": "integer",
        "total_pass": "integer",
        "total_skip": "integer"
      },
      "id": "",
      "relationships": {
        "entity": {
          "data": {
            "id": "",
            "type": ""
          }
        },
        "rule": {
          "data": {
            "id": "",
            "type": ""
          }
        },
        "scorecard": {
          "data": {
            "id": "",
            "type": ""
          }
        },
        "service": {
          "data": {
            "id": "",
            "type": ""
          }
        },
        "team": {
          "data": {
            "id": "",
            "type": ""
          }
        }
      },
      "type": "score"
    }
  ],
  "links": {
    "next": "/api/v2/scorecard/rules?page%5Blimit%5D=2\u0026page%5Boffset%5D=2\u0026page%5Bsize%5D=2"
  },
  "meta": {
    "count": "integer",
    "limit": "integer",
    "offset": "integer",
    "total": "integer"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export aggregation="by-entity"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"