scorecard_scores

Creates, updates, deletes, gets or lists a scorecard_scores resource.

Overview

Name	scorecard_scores
Type	Resource
Id	datadog.apm.scorecard_scores

Fields

The following fields are returned by SELECT queries:

list_scorecard_scores

Name	Datatype	Description
id	string	The ID of the entity or resource being scored. (example: )
attributes	object	Attributes of a scorecard score.
relationships	object	Relationships for a scorecard score, depending on the aggregation type.
type	string	The JSON:API resource type. (score) (default: score, example: score)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_scorecard_scores	select	aggregation	filter[rule][id], filter[rule][name], filter[rule][level], filter[rule][scorecard_id], filter[rule][is_custom], filter[rule][is_enabled], sort, page[offset], page[limit]	Returns a list of scorecard scores for each aggregation type, with score breakdowns.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aggregation	string	The type of scores being requested.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
filter[rule][id]	string	Filter scores by rule 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.
filter[rule][level]	string	Filter scores by rule level(s), comma-separated.
filter[rule][name]	string	Filter scores by rule name.
filter[rule][scorecard_id]	string	Filter scores by scorecard ID(s), comma-separated.
page[limit]	integer (int64)	Number of scores to return. Max is 1000.
page[offset]	integer (int64)	Offset for pagination.
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.

SELECT examples

list_scorecard_scores

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

SELECT
id,
attributes,
relationships,
type
FROM datadog.apm.scorecard_scores
WHERE aggregation = '{{ aggregation }}' -- required
AND filter[rule][id] = '{{ filter[rule][id] }}'
AND filter[rule][name] = '{{ filter[rule][name] }}'
AND filter[rule][level] = '{{ filter[rule][level] }}'
AND filter[rule][scorecard_id] = '{{ filter[rule][scorecard_id] }}'
AND filter[rule][is_custom] = '{{ filter[rule][is_custom] }}'
AND filter[rule][is_enabled] = '{{ filter[rule][is_enabled] }}'
AND sort = '{{ sort }}'
AND page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
;