scorecard_outcomes

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

Overview

Name	scorecard_outcomes
Type	Resource
Id	datadog.apm.scorecard_outcomes

Fields

The following fields are returned by SELECT queries:

list_scorecard_outcomes

Name	Datatype	Description
id	string	The unique ID for a rule outcome.
attributes	object	The JSON:API attributes for an outcome.
relationships	object	The JSON:API relationship to a scorecard rule.
type	string	The JSON:API type for an outcome. (outcome) (default: outcome, example: outcome)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_scorecard_outcomes	select		page[size], page[offset], include, fields[outcome], fields[rule], filter[outcome][service_name], filter[outcome][state], filter[rule][enabled], filter[rule][id], filter[rule][name]	Fetches all rule outcomes.
update_scorecard_outcomes	insert			Updates multiple scorecard rule outcomes in a single batched request.

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.
fields[outcome]	string	Return only specified values in the outcome attributes.
fields[rule]	string	Return only specified values in the included rule details.
filter[outcome][service_name]	string	Filter outcomes on a specific service name.
filter[outcome][state]	string	Filter outcomes by a specific state.
filter[rule][enabled]	boolean	Filter outcomes based on whether a rule is enabled or disabled.
filter[rule][id]	string	Filter outcomes based on rule ID.
filter[rule][name]	string	Filter outcomes based on rule name.
include	string	Include related rule details in the response.
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.
page[size]	integer (int64)	Number of items to return per page. The maximum allowed value is 100.

SELECT examples

list_scorecard_outcomes

Fetches all rule outcomes.

SELECT
id,
attributes,
relationships,
type
FROM datadog.apm.scorecard_outcomes
WHERE page[size] = '{{ page[size] }}'
AND page[offset] = '{{ page[offset] }}'
AND include = '{{ include }}'
AND fields[outcome] = '{{ fields[outcome] }}'
AND fields[rule] = '{{ fields[rule] }}'
AND filter[outcome][service_name] = '{{ filter[outcome][service_name] }}'
AND filter[outcome][state] = '{{ filter[outcome][state] }}'
AND filter[rule][enabled] = '{{ filter[rule][enabled] }}'
AND filter[rule][id] = '{{ filter[rule][id] }}'
AND filter[rule][name] = '{{ filter[rule][name] }}'
;

INSERT examples

update_scorecard_outcomes

Updates multiple scorecard rule outcomes in a single batched request.

INSERT INTO datadog.apm.scorecard_outcomes (
data
)
SELECT 
'{{ data }}'
;

Manifest

# Description fields are for documentation purposes
- name: scorecard_outcomes
props:
  - name: data
    description: |
      Scorecard outcomes batch request data.
    value:
      attributes:
        results:
          - entity_reference: "{{ entity_reference }}"
            remarks: "{{ remarks }}"
            rule_id: "{{ rule_id }}"
            state: "{{ state }}"
      type: "{{ type }}"