scorecards
Creates, updates, deletes, gets or lists a scorecards resource.
Overview
| Name | scorecards |
| Type | Resource |
| Id | datadog.apm.scorecards |
Fields
The following fields are returned by SELECT queries:
- list_scorecards
| Name | Datatype | Description |
|---|---|---|
id | string | The unique ID of the scorecard. (example: q8MQxk8TCqrHnWkx) |
attributes | object | Scorecard attributes. |
type | string | The JSON:API type for scorecard list. (scorecard) (example: scorecard) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_scorecards | select | page[offset], page[size], filter[scorecard][id], filter[scorecard][name], filter[scorecard][description] | Fetches all scorecards. |
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 |
|---|---|---|
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[scorecard][description] | string | Filter by scorecard description (partial match). |
filter[scorecard][id] | string | Filter by scorecard ID. |
filter[scorecard][name] | string | Filter by scorecard name (partial match). |
page[offset] | integer (int64) | Offset for pagination. |
page[size] | integer (int64) | Maximum number of scorecards to return. |
SELECT examples
- list_scorecards
Fetches all scorecards.
SELECT
id,
attributes,
type
FROM datadog.apm.scorecards
WHERE page[offset] = '{{ page[offset] }}'
AND page[size] = '{{ page[size] }}'
AND filter[scorecard][id] = '{{ filter[scorecard][id] }}'
AND filter[scorecard][name] = '{{ filter[scorecard][name] }}'
AND filter[scorecard][description] = '{{ filter[scorecard][description] }}'
;