Skip to Content
API ReferenceMetrics DebuggingList Pipeline Events

List Pipeline Events

GET/v0/pipelines/{pipeline_name}/events
Authentication
Parameters

Retrieve monitoring events in reverse chronological order.

Pipeline health is monitored regularly every several seconds. Not every monitoring action results in a pipeline monitor event being constructed and inserted into the database. This happens if:

  • Any status changed
  • Only the status details changed, and it has been 10s since the last event
  • Nothing has changed for more than 10 minutes

This endpoint returns the most recent persisted events, up to by default approximately 720.

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name

Query parameters

NameTypeRequiredDescription
selectorPipelineMonitorEventFieldSelectorNoThe `selector` parameter limits which fields are returned. Limiting which fields is particularly handy for instance when frequently monitoring over low bandwidth connections while being only interested in status.

Response

application/json
  • PipelineMonitorEventSelectedInfo[]
    • object
      Pipeline monitor event information which has a selected subset of optional fields. If an optional field is not selected (i.e., is `None`), it will not be serialized.
Request
curl -X GET '/v0/pipelines/{pipeline_name}/events?selector=%3Cselector%3E' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
[]