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. (example: citest)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_ciapp_test_events	select	region	filter[query], filter[from], filter[to], sort, page[cursor], page[limit]	List endpoint returns CI Visibility test events that match a search query. Results are paginated similarly to logs. Use this endpoint to see your latest test events.
search_ciapp_test_events	insert	region		List endpoint returns CI Visibility test events that match a search query. Results are paginated similarly to logs. Use this endpoint to build complex events filtering and search.
aggregate_ciapp_test_events	exec	region		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
region	string	(default: datadoghq.com)
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.
Results are paginated similarly to logs.

Use this endpoint to see your latest test events.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.ci_app_test_events
WHERE region = '{{ region }}' -- required
AND 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.
Results are paginated similarly to logs.

Use this endpoint to build complex events filtering and search.

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

Manifest

# Description fields are for documentation purposes
- name: ci_app_test_events
  props:
    - name: region
      value: string
      description: Required parameter for the ci_app_test_events resource.
    - name: filter
      value: object
      description: |
        The search and filter query settings.
    - name: options
      value: object
      description: |
        Global query options that are used during the query.
        Only supply timezone or time offset, not both. Otherwise, the query fails.
    - name: page
      value: object
      description: |
        Paging attributes for listing events.
    - name: sort
      value: string
      description: |
        Sort parameters when querying events.
      valid_values: ['timestamp', '-timestamp']

Lifecycle Methods

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 
@region='{{ region }}' --required 
@@json=
'{
"compute": "{{ compute }}", 
"filter": "{{ filter }}", 
"group_by": "{{ group_by }}", 
"options": "{{ options }}"
}'
;