For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ja/api/latest/scorecards/list-all-scores.md. A documentation index is available at /llms.txt.
homeホームdocsドキュメントapiAPI
Language
Datadog site

List all scores

GEThttps://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}https://api.datadoghq.eu/api/v2/scorecard/scores/{aggregation}https://api.ap1.datadoghq.com/api/v2/scorecard/scores/{aggregation}https://api.ap2.datadoghq.com/api/v2/scorecard/scores/{aggregation}https://api.uk1.datadoghq.com/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}

概要

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.

引数

パスパラメーター

名前
タイプ
説明
aggregation [required]
enum

The type of scores being requested.

Allowed enum values: by-entity, by-rule, by-scorecard, by-team, by-kind

クエリ文字列

名前
タイプ
説明
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.

Default: 0
page[limit]
integer

Number of scores to return. Max is 1000.

Default: 100

応答

OK

A list of scorecard scores for a given aggregation type.

フィールド
タイプ
説明
data
[object]

Array of score objects.

links
object

Links attributes.

meta
object

Pagination metadata for scores.

コード例

List all scores
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export aggregation="by-entity"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scorecard/scores/${aggregation}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"