ci_app_test_events

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

Overview

Name	ci_app_test_events
Type	Resource
Id	datadog.software_delivery.ci_app_test_events

Fields

The following fields are returned by SELECT queries:

list_ciapp_test_events

Name	Datatype	Description
id	string	Unique ID of the event. (example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA)
attributes	object	JSON object containing all event attributes and their associated values.
type	string	Type of the event. (citest) (example: citest)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_ciapp_test_events	select		filter[query], filter[from], filter[to], sort, page[cursor], page[limit]	List endpoint returns CI Visibility test events that match a [search query](https:​//docs.datadoghq.com/continuous_integration/explorer/search_syntax/).<br />[Results are paginated similarly to logs](https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).<br /><br />Use this endpoint to see your latest test events.
search_ciapp_test_events	insert			List endpoint returns CI Visibility test events that match a [search query](https:​//docs.datadoghq.com/continuous_integration/explorer/search_syntax/).<br />[Results are paginated similarly to logs](https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).<br /><br />Use this endpoint to build complex events filtering and search.
aggregate_ciapp_test_events	exec			The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries.

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[from]	string (date-time)	Minimum timestamp for requested events. (example: 2019-01-02T09:42:36.320Z)
filter[query]	string	Search query following log syntax. (example: @test.name:test_foo @test.suite:github.com/DataDog/dd-go/model)
filter[to]	string (date-time)	Maximum timestamp for requested events. (example: 2019-01-03T09:42:36.320Z)
page[cursor]	string	List following results with a cursor provided in the previous query. (example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==)
page[limit]	integer (int32)	Maximum number of events in the response. (example: 25)
sort	string	Order of events in results.

SELECT examples

list_ciapp_test_events

List endpoint returns CI Visibility test events that match a [search query](https:​//docs.datadoghq.com/continuous_integration/explorer/search_syntax/).<br />[Results are paginated similarly to logs](https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).<br /><br />Use this endpoint to see your latest test events.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.ci_app_test_events
WHERE filter[query] = '{{ filter[query] }}'
AND filter[from] = '{{ filter[from] }}'
AND filter[to] = '{{ filter[to] }}'
AND sort = '{{ sort }}'
AND page[cursor] = '{{ page[cursor] }}'
AND page[limit] = '{{ page[limit] }}'
;

INSERT examples

search_ciapp_test_events

List endpoint returns CI Visibility test events that match a [search query](https:​//docs.datadoghq.com/continuous_integration/explorer/search_syntax/).<br />[Results are paginated similarly to logs](https:​//docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).<br /><br />Use this endpoint to build complex events filtering and search.

INSERT INTO datadog.software_delivery.ci_app_test_events (
filter,
options,
page,
sort
)
SELECT 
'{{ filter }}',
'{{ options }}',
'{{ page }}',
'{{ sort }}'
RETURNING
data,
links,
meta
;

Manifest

# Description fields are for documentation purposes
- name: ci_app_test_events
props:
  - name: filter
    description: |
      The search and filter query settings.
    value:
      from: "{{ from }}"
      query: "{{ query }}"
      to: "{{ to }}"
  - name: options
    description: |
      Global query options that are used during the query.
      Only supply timezone or time offset, not both. Otherwise, the query fails.
    value:
      time_offset: {{ time_offset }}
      timezone: "{{ timezone }}"
  - name: page
    description: |
      Paging attributes for listing events.
    value:
      cursor: "{{ cursor }}"
      limit: {{ limit }}
  - name: sort
    value: "{{ sort }}"
    description: |
      Sort parameters when querying events.
    valid_values: ['timestamp', '-timestamp']

Lifecycle Methods

EXEC variables use wire (API) names.

aggregate_ciapp_test_events

The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries.

EXEC datadog.software_delivery.ci_app_test_events.aggregate_ciapp_test_events 
@@json=
'{
"compute": "{{ compute }}", 
"filter": "{{ filter }}", 
"group_by": "{{ group_by }}", 
"options": "{{ options }}"
}'
;