POST https://api.ap1.datadoghq.com/api/v2/ci/pipelines/events/search https://api.ap2.datadoghq.com/api/v2/ci/pipelines/events/search https://api.datadoghq.eu/api/v2/ci/pipelines/events/search https://api.ddog-gov.com/api/v2/ci/pipelines/events/search https://api.us2.ddog-gov.com/api/v2/ci/pipelines/events/search https://api.datadoghq.com/api/v2/ci/pipelines/events/search https://api.us3.datadoghq.com/api/v2/ci/pipelines/events/search https://api.us5.datadoghq.com/api/v2/ci/pipelines/events/search
Overview
List endpoint returns CI Visibility pipeline events that match a search query .
Results are paginated similarly to logs .
Use this endpoint to build complex events filtering and search.
This endpoint requires the
ci_visibility_read permission.
OAuth apps require the ci_visibility_read authorization scope to access this endpoint.
Request Body Data
Expand All
The search and filter query settings.
The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds).
default: now-15m
The search query following the CI Visibility Explorer search syntax.
default: *
The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds).
default: now
Global query options that are used during the query.
Only supply timezone or time offset, not both. Otherwise, the query fails.
The time offset (in seconds) to apply to the query.
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
Paging attributes for listing events.
List following results with a cursor provided in the previous query.
Maximum number of events in the response.
default: 10
Sort parameters when querying events.
Allowed enum values: timestamp,-timestamp
{
"filter" : {
"from" : "now-15m" ,
"query" : "@ci.provider.name:github AND @ci.status:error" ,
"to" : "now"
},
"options" : {
"timezone" : "GMT"
},
"page" : {
"limit" : 5
},
"sort" : "timestamp"
} {
"filter" : {
"from" : "now-30s" ,
"to" : "now"
},
"options" : {
"timezone" : "GMT"
},
"page" : {
"limit" : 2
},
"sort" : "timestamp"
} Response OK
Response object with all pipeline events matching the request and pagination information.
Expand All
Array of events matching the request.
JSON object containing all event attributes and their associated values.
JSON object of attributes from CI Visibility pipeline events.
Pipeline execution level.
Allowed enum values: pipeline,stage,job,step,custom
Array of tags associated with your event.
Type of the event.
Allowed enum values: cipipeline
Link for the next set of results. The request can also be made using the
POST endpoint.
The metadata associated with a request.
The time elapsed in milliseconds.
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].
The identifier of the request.
The status of the response.
Allowed enum values: done,timeout
A list of warnings (non-fatal errors) encountered. Partial results may return if
warnings are present in the response.
A unique code for this type of warning.
A detailed explanation of this specific warning.
A short human-readable summary of the warning.
{
"data" : [
{
"attributes" : {
"attributes" : {
"customAttribute" : 123 ,
"duration" : 2345
},
"ci_level" : "pipeline" ,
"tags" : [
"team:A"
]
},
"id" : "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" ,
"type" : "cipipeline"
}
],
"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"
}
]
}
} Bad Request
{
"errors" : [
"Bad Request"
]
} Not Authorized
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
## default
#
# Curl command curl -X POST "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/ci/pipelines/events/search " \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"filter": {
"from": "now-15m",
"query": "@ci.provider.name:github AND @ci.status:error",
"to": "now"
},
"options": {
"timezone": "GMT"
},
"page": {
"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"limit": 25
},
"sort": "timestamp"
}
EOF
Copy
## default
#
# Curl command curl -X POST "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/ci/pipelines/events/search " \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} " \
-d @- << EOF
{
"filter": {
"from": "now-15m",
"query": "@ci.provider.name:github AND @ci.status:error",
"to": "now"
},
"options": {
"timezone": "GMT"
},
"page": {
"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",
"limit": 25
},
"sort": "timestamp"
}
EOF
// Search pipelines events returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main () {
body := datadogV2 . CIAppPipelineEventsRequest {
Filter : & datadogV2 . CIAppPipelinesQueryFilter {
From : datadog . PtrString ( "now-15m" ),
Query : datadog . PtrString ( "@ci.provider.name:github AND @ci.status:error" ),
To : datadog . PtrString ( "now" ),
},
Options : & datadogV2 . CIAppQueryOptions {
Timezone : datadog . PtrString ( "GMT" ),
},
Page : & datadogV2 . CIAppQueryPageOptions {
Limit : datadog . PtrInt32 ( 5 ),
},
Sort : datadogV2 . CIAPPSORT_TIMESTAMP_ASCENDING . Ptr (),
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewCIVisibilityPipelinesApi ( apiClient )
resp , r , err := api . SearchCIAppPipelineEvents ( ctx , * datadogV2 . NewSearchCIAppPipelineEventsOptionalParameters (). WithBody ( body ))
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `CIVisibilityPipelinesApi.SearchCIAppPipelineEvents`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `CIVisibilityPipelinesApi.SearchCIAppPipelineEvents`:\n%s\n" , responseContent )
}
// Search pipelines events returns "OK" response with pagination
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main () {
body := datadogV2 . CIAppPipelineEventsRequest {
Filter : & datadogV2 . CIAppPipelinesQueryFilter {
From : datadog . PtrString ( "now-30s" ),
To : datadog . PtrString ( "now" ),
},
Options : & datadogV2 . CIAppQueryOptions {
Timezone : datadog . PtrString ( "GMT" ),
},
Page : & datadogV2 . CIAppQueryPageOptions {
Limit : datadog . PtrInt32 ( 2 ),
},
Sort : datadogV2 . CIAPPSORT_TIMESTAMP_ASCENDING . Ptr (),
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewCIVisibilityPipelinesApi ( apiClient )
resp , _ := api . SearchCIAppPipelineEventsWithPagination ( ctx , * datadogV2 . NewSearchCIAppPipelineEventsOptionalParameters (). WithBody ( body ))
for paginationResult := range resp {
if paginationResult . Error != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `CIVisibilityPipelinesApi.SearchCIAppPipelineEvents`: %v\n" , paginationResult . Error )
}
responseContent , _ := json . MarshalIndent ( paginationResult . Item , "" , " " )
fmt . Fprintf ( os . Stdout , "%s\n" , responseContent )
}
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Search pipelines events returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.CiVisibilityPipelinesApi ;
import com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters ;
import com.datadog.api.client.v2.model.CIAppPipelineEventsRequest ;
import com.datadog.api.client.v2.model.CIAppPipelineEventsResponse ;
import com.datadog.api.client.v2.model.CIAppPipelinesQueryFilter ;
import com.datadog.api.client.v2.model.CIAppQueryOptions ;
import com.datadog.api.client.v2.model.CIAppQueryPageOptions ;
import com.datadog.api.client.v2.model.CIAppSort ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
CiVisibilityPipelinesApi apiInstance = new CiVisibilityPipelinesApi ( defaultClient );
CIAppPipelineEventsRequest body =
new CIAppPipelineEventsRequest ()
. filter (
new CIAppPipelinesQueryFilter ()
. from ( "now-15m" )
. query ( "@ci.provider.name:github AND @ci.status:error" )
. to ( "now" ))
. options ( new CIAppQueryOptions (). timezone ( "GMT" ))
. page ( new CIAppQueryPageOptions (). limit ( 5 ))
. sort ( CIAppSort . TIMESTAMP_ASCENDING );
try {
CIAppPipelineEventsResponse result =
apiInstance . searchCIAppPipelineEvents (
new SearchCIAppPipelineEventsOptionalParameters (). body ( body ));
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println (
"Exception when calling CiVisibilityPipelinesApi#searchCIAppPipelineEvents" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
// Search pipelines events returns "OK" response with pagination
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.PaginationIterable ;
import com.datadog.api.client.v2.api.CiVisibilityPipelinesApi ;
import com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters ;
import com.datadog.api.client.v2.model.CIAppPipelineEvent ;
import com.datadog.api.client.v2.model.CIAppPipelineEventsRequest ;
import com.datadog.api.client.v2.model.CIAppPipelinesQueryFilter ;
import com.datadog.api.client.v2.model.CIAppQueryOptions ;
import com.datadog.api.client.v2.model.CIAppQueryPageOptions ;
import com.datadog.api.client.v2.model.CIAppSort ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
CiVisibilityPipelinesApi apiInstance = new CiVisibilityPipelinesApi ( defaultClient );
CIAppPipelineEventsRequest body =
new CIAppPipelineEventsRequest ()
. filter ( new CIAppPipelinesQueryFilter (). from ( "now-30s" ). to ( "now" ))
. options ( new CIAppQueryOptions (). timezone ( "GMT" ))
. page ( new CIAppQueryPageOptions (). limit ( 2 ))
. sort ( CIAppSort . TIMESTAMP_ASCENDING );
try {
PaginationIterable < CIAppPipelineEvent > iterable =
apiInstance . searchCIAppPipelineEventsWithPagination (
new SearchCIAppPipelineEventsOptionalParameters (). body ( body ));
for ( CIAppPipelineEvent item : iterable ) {
System . out . println ( item );
}
} catch ( RuntimeException e ) {
System . err . println (
"Exception when calling"
+ " CiVisibilityPipelinesApi#searchCIAppPipelineEventsWithPagination" );
System . err . println ( "Reason: " + e . getMessage ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
"""
Search pipelines events returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.ci_visibility_pipelines_api import CIVisibilityPipelinesApi
from datadog_api_client.v2.model.ci_app_pipeline_events_request import CIAppPipelineEventsRequest
from datadog_api_client.v2.model.ci_app_pipelines_query_filter import CIAppPipelinesQueryFilter
from datadog_api_client.v2.model.ci_app_query_options import CIAppQueryOptions
from datadog_api_client.v2.model.ci_app_query_page_options import CIAppQueryPageOptions
from datadog_api_client.v2.model.ci_app_sort import CIAppSort
body = CIAppPipelineEventsRequest (
filter = CIAppPipelinesQueryFilter (
_from = "now-15m" ,
query = "@ci.provider.name:github AND @ci.status:error" ,
to = "now" ,
),
options = CIAppQueryOptions (
timezone = "GMT" ,
),
page = CIAppQueryPageOptions (
limit = 5 ,
),
sort = CIAppSort . TIMESTAMP_ASCENDING ,
)
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = CIVisibilityPipelinesApi ( api_client )
response = api_instance . search_ci_app_pipeline_events ( body = body )
print ( response )
"""
Search pipelines events returns "OK" response with pagination
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.ci_visibility_pipelines_api import CIVisibilityPipelinesApi
from datadog_api_client.v2.model.ci_app_pipeline_events_request import CIAppPipelineEventsRequest
from datadog_api_client.v2.model.ci_app_pipelines_query_filter import CIAppPipelinesQueryFilter
from datadog_api_client.v2.model.ci_app_query_options import CIAppQueryOptions
from datadog_api_client.v2.model.ci_app_query_page_options import CIAppQueryPageOptions
from datadog_api_client.v2.model.ci_app_sort import CIAppSort
body = CIAppPipelineEventsRequest (
filter = CIAppPipelinesQueryFilter (
_from = "now-30s" ,
to = "now" ,
),
options = CIAppQueryOptions (
timezone = "GMT" ,
),
page = CIAppQueryPageOptions (
limit = 2 ,
),
sort = CIAppSort . TIMESTAMP_ASCENDING ,
)
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = CIVisibilityPipelinesApi ( api_client )
items = api_instance . search_ci_app_pipeline_events_with_pagination ( body = body )
for item in items :
print ( item )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Search pipelines events returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: CIVisibilityPipelinesAPI . new
body = DatadogAPIClient :: V2 :: CIAppPipelineEventsRequest . new ({
filter : DatadogAPIClient :: V2 :: CIAppPipelinesQueryFilter . new ({
from : "now-15m" ,
query : "@ci.provider.name:github AND @ci.status:error" ,
to : "now" ,
}),
options : DatadogAPIClient :: V2 :: CIAppQueryOptions . new ({
timezone : "GMT" ,
}),
page : DatadogAPIClient :: V2 :: CIAppQueryPageOptions . new ({
limit : 5 ,
}),
sort : DatadogAPIClient :: V2 :: CIAppSort :: TIMESTAMP_ASCENDING ,
})
opts = {
body : body ,
}
p api_instance . search_ci_app_pipeline_events ( opts )
# Search pipelines events returns "OK" response with pagination
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: CIVisibilityPipelinesAPI . new
body = DatadogAPIClient :: V2 :: CIAppPipelineEventsRequest . new ({
filter : DatadogAPIClient :: V2 :: CIAppPipelinesQueryFilter . new ({
from : "now-30s" ,
to : "now" ,
}),
options : DatadogAPIClient :: V2 :: CIAppQueryOptions . new ({
timezone : "GMT" ,
}),
page : DatadogAPIClient :: V2 :: CIAppQueryPageOptions . new ({
limit : 2 ,
}),
sort : DatadogAPIClient :: V2 :: CIAppSort :: TIMESTAMP_ASCENDING ,
})
opts = {
body : body ,
}
api_instance . search_ci_app_pipeline_events_with_pagination ( opts ) { | item | puts item }
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Search pipelines events returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_ci_visibility_pipelines ::CIVisibilityPipelinesAPI ;
use datadog_api_client ::datadogV2 ::api_ci_visibility_pipelines ::SearchCIAppPipelineEventsOptionalParams ;
use datadog_api_client ::datadogV2 ::model ::CIAppPipelineEventsRequest ;
use datadog_api_client ::datadogV2 ::model ::CIAppPipelinesQueryFilter ;
use datadog_api_client ::datadogV2 ::model ::CIAppQueryOptions ;
use datadog_api_client ::datadogV2 ::model ::CIAppQueryPageOptions ;
use datadog_api_client ::datadogV2 ::model ::CIAppSort ;
#[tokio::main]
async fn main () {
let body = CIAppPipelineEventsRequest ::new ()
. filter (
CIAppPipelinesQueryFilter ::new ()
. from ( "now-15m" . to_string ())
. query ( "@ci.provider.name:github AND @ci.status:error" . to_string ())
. to ( "now" . to_string ()),
)
. options ( CIAppQueryOptions ::new (). timezone ( "GMT" . to_string ()))
. page ( CIAppQueryPageOptions ::new (). limit ( 5 ))
. sort ( CIAppSort ::TIMESTAMP_ASCENDING );
let configuration = datadog ::Configuration ::new ();
let api = CIVisibilityPipelinesAPI ::with_config ( configuration );
let resp = api
. search_ci_app_pipeline_events (
SearchCIAppPipelineEventsOptionalParams ::default (). body ( body ),
)
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
// Search pipelines events returns "OK" response with pagination
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_ci_visibility_pipelines ::CIVisibilityPipelinesAPI ;
use datadog_api_client ::datadogV2 ::api_ci_visibility_pipelines ::SearchCIAppPipelineEventsOptionalParams ;
use datadog_api_client ::datadogV2 ::model ::CIAppPipelineEventsRequest ;
use datadog_api_client ::datadogV2 ::model ::CIAppPipelinesQueryFilter ;
use datadog_api_client ::datadogV2 ::model ::CIAppQueryOptions ;
use datadog_api_client ::datadogV2 ::model ::CIAppQueryPageOptions ;
use datadog_api_client ::datadogV2 ::model ::CIAppSort ;
use futures_util ::pin_mut ;
use futures_util ::stream ::StreamExt ;
#[tokio::main]
async fn main () {
let body = CIAppPipelineEventsRequest ::new ()
. filter (
CIAppPipelinesQueryFilter ::new ()
. from ( "now-30s" . to_string ())
. to ( "now" . to_string ()),
)
. options ( CIAppQueryOptions ::new (). timezone ( "GMT" . to_string ()))
. page ( CIAppQueryPageOptions ::new (). limit ( 2 ))
. sort ( CIAppSort ::TIMESTAMP_ASCENDING );
let configuration = datadog ::Configuration ::new ();
let api = CIVisibilityPipelinesAPI ::with_config ( configuration );
let response = api . search_ci_app_pipeline_events_with_pagination (
SearchCIAppPipelineEventsOptionalParams ::default (). body ( body ),
);
pin_mut! ( response );
while let Some ( resp ) = response . next (). await {
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Search pipelines events returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . CIVisibilityPipelinesApi ( configuration );
const params : v2.CIVisibilityPipelinesApiSearchCIAppPipelineEventsRequest = {
body : {
filter : {
from : "now-15m" ,
query : "@ci.provider.name:github AND @ci.status:error" ,
to : "now" ,
},
options : {
timezone : "GMT" ,
},
page : {
limit : 5 ,
},
sort : "timestamp" ,
},
};
apiInstance
. searchCIAppPipelineEvents ( params )
. then (( data : v2.CIAppPipelineEventsResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
/**
* Search pipelines events returns "OK" response with pagination
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . CIVisibilityPipelinesApi ( configuration );
const params : v2.CIVisibilityPipelinesApiSearchCIAppPipelineEventsRequest = {
body : {
filter : {
from : "now-30s" ,
to : "now" ,
},
options : {
timezone : "GMT" ,
},
page : {
limit : 2 ,
},
sort : "timestamp" ,
},
};
( async () => {
try {
for await ( const item of apiInstance . searchCIAppPipelineEventsWithPagination (
params
)) {
console . log ( item );
}
} catch ( error ) {
console . error ( error );
}
})();
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"