The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds).
default: now-15m
query
string
The search query following the CI Visibility Explorer search syntax.
default: *
to
string
The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds).
default: now
options
object
Global query options that are used during the query.
Only supply timezone or time offset, not both. Otherwise, the query fails.
time_offset
int64
The time offset (in seconds) to apply to the query.
timezone
string
The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).
default: UTC
page
object
Paging attributes for listing events.
cursor
string
List following results with a cursor provided in the previous query.
limit
int32
Maximum number of events in the response.
default: 10
sort
enum
Sort parameters when querying events.
Allowed enum values: timestamp,-timestamp
{"filter":{"from":"now-15m","query":"@test.service:web-ui-tests AND @test.status:skip","to":"now"},"options":{"timezone":"GMT"},"page":{"limit":25},"sort":"timestamp"}
{"filter":{"from":"now-15m","query":"@test.status:pass AND -@language:python","to":"now"},"page":{"limit":2},"sort":"timestamp"}
Response object with all test events matching the request and pagination information.
Expand All
Field
Type
Description
data
[object]
Array of events matching the request.
attributes
object
JSON object containing all event attributes and their associated values.
attributes
object
JSON object of attributes from CI Visibility test events.
tags
[string]
Array of tags associated with your event.
test_level
enum
Test run level.
Allowed enum values: session,module,suite,test
id
string
Unique ID of the event.
type
enum
Type of the event.
Allowed enum values: citest
links
object
Links attributes.
next
string
Link for the next set of results. The request can also be made using the
POST endpoint.
meta
object
The metadata associated with a request.
elapsed
int64
The time elapsed in milliseconds.
page
object
Paging attributes.
after
string
The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor].
request_id
string
The identifier of the request.
status
enum
The status of the response.
Allowed enum values: done,timeout
warnings
[object]
A list of warnings (non-fatal errors) encountered. Partial results may return if
warnings are present in the response.
code
string
A unique code for this type of warning.
detail
string
A detailed explanation of this specific warning.
title
string
A short human-readable summary of the warning.
{"data":[{"attributes":{"attributes":{"customAttribute":123,"duration":2345},"tags":["team:A"],"test_level":"test"},"id":"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA","type":"citest"}],"links":{"next":"https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo\u0026page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="},"meta":{"elapsed":132,"page":{"after":"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="},"request_id":"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR","status":"done","warnings":[{"code":"unknown_index","detail":"indexes: foo, bar","title":"One or several indexes are missing or invalid, results hold data from the other indexes"}]}}
// Search tests events returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.CiVisibilityTestsApi;importcom.datadog.api.client.v2.api.CiVisibilityTestsApi.SearchCIAppTestEventsOptionalParameters;importcom.datadog.api.client.v2.model.CIAppQueryOptions;importcom.datadog.api.client.v2.model.CIAppQueryPageOptions;importcom.datadog.api.client.v2.model.CIAppSort;importcom.datadog.api.client.v2.model.CIAppTestEventsRequest;importcom.datadog.api.client.v2.model.CIAppTestEventsResponse;importcom.datadog.api.client.v2.model.CIAppTestsQueryFilter;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();CiVisibilityTestsApiapiInstance=newCiVisibilityTestsApi(defaultClient);CIAppTestEventsRequestbody=newCIAppTestEventsRequest().filter(newCIAppTestsQueryFilter().from("now-15m").query("@test.service:web-ui-tests AND @test.status:skip").to("now")).options(newCIAppQueryOptions().timezone("GMT")).page(newCIAppQueryPageOptions().limit(25)).sort(CIAppSort.TIMESTAMP_ASCENDING);try{CIAppTestEventsResponseresult=apiInstance.searchCIAppTestEvents(newSearchCIAppTestEventsOptionalParameters().body(body));System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling CiVisibilityTestsApi#searchCIAppTestEvents");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Search tests events returns "OK" response with paginationimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.PaginationIterable;importcom.datadog.api.client.v2.api.CiVisibilityTestsApi;importcom.datadog.api.client.v2.api.CiVisibilityTestsApi.SearchCIAppTestEventsOptionalParameters;importcom.datadog.api.client.v2.model.CIAppQueryPageOptions;importcom.datadog.api.client.v2.model.CIAppSort;importcom.datadog.api.client.v2.model.CIAppTestEvent;importcom.datadog.api.client.v2.model.CIAppTestEventsRequest;importcom.datadog.api.client.v2.model.CIAppTestsQueryFilter;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();CiVisibilityTestsApiapiInstance=newCiVisibilityTestsApi(defaultClient);CIAppTestEventsRequestbody=newCIAppTestEventsRequest().filter(newCIAppTestsQueryFilter().from("now-15m").query("@test.status:pass AND -@language:python").to("now")).page(newCIAppQueryPageOptions().limit(2)).sort(CIAppSort.TIMESTAMP_ASCENDING);try{PaginationIterable<CIAppTestEvent>iterable=apiInstance.searchCIAppTestEventsWithPagination(newSearchCIAppTestEventsOptionalParameters().body(body));for(CIAppTestEventitem:iterable){System.out.println(item);}}catch(RuntimeExceptione){System.err.println("Exception when calling CiVisibilityTestsApi#searchCIAppTestEventsWithPagination");System.err.println("Reason: "+e.getMessage());e.printStackTrace();}}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Search tests events returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.CIVisibilityTestsApi(configuration);constparams: v2.CIVisibilityTestsApiSearchCIAppTestEventsRequest={body:{filter:{from:"now-15m",query:"@test.service:web-ui-tests AND @test.status:skip",to:"now",},options:{timezone:"GMT",},page:{limit: 25,},sort:"timestamp",},};apiInstance.searchCIAppTestEvents(params).then((data: v2.CIAppTestEventsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Search tests events returns "OK" response with pagination
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.CIVisibilityTestsApi(configuration);constparams: v2.CIVisibilityTestsApiSearchCIAppTestEventsRequest={body:{filter:{from:"now-15m",query:"@test.status:pass AND -@language:python",to:"now",},page:{limit: 2,},sort:"timestamp",},};(async()=>{try{forawait(constitemofapiInstance.searchCIAppTestEventsWithPagination(params)){console.log(item);}}catch(error){console.error(error);}})();