Skip to content

Pipeline Runs

APIs to manage Pipeline Runs. Pipeline run status descriptions

  • PENDING - Pipeline run created.
  • QUEUED - Pipeline run queued for processing.
  • PROCESSING - Pipeline run received by scheduler for processing. (Processing a pipeline involves performing the operations required before starting a pipeline)
  • RUNNING - Pipeline run has started running.
  • WAITING - Pipeline run is waiting for an action (manual/automatic).
  • COMPLETE - The pipeline run has completed processing i.e. All stage runs are processed. A complete pipeline run can move to success or failure.
  • SUCCESS - A completed pipeline run moves to success if all stage runs are successful.
  • FAILURE - A completed pipeline run moves to failure if all stage runs are not successful.
  • CANCELLED - Pipeline run is cancelled by the user.
  • TIMEOUT - The pipeline run has a timed out. This happens when the pipeline has not completed processing even after the timeout period (Default 21 days).
  • INVALID - A pipeline run moves to invalid state when Pipeline run has no stageruns i.e pipeline has zero stages.
Operations

Get all Runs for the Pipelines in the Enterprise
Stable

Request

Retrieves all Pipeline Runs across the enterprise, with optional filtering.

Returns Pipeline Run records for every pipeline in the enterprise, rather than scoped to a single pipeline, and supports filtering by status and pipeline name.

About Pipeline Runs (Enterprise-wide) A Pipeline Run is a single execution instance of a Pipeline. This enterprise-wide endpoint is the broadest view of pipeline activity, useful for monitoring or dashboarding across all pipelines rather than checking one at a time.

Key Fields / Query Parameters

  • status — Filter runs by their current status (e.g., pending, running, success, failure)
  • pipeline_name — Filter runs by the name of the parent pipeline
  • ordering — Field to sort results by
Security
pipelines_SCAPIAuthToken
Query
statusstring

Filter by pipeline run status

Enum:"pending""queued""processing""running""waiting""complete""success""failure""cancelled""invalid"
pipeline_namestring

Filter by pipeline name

orderingstring

Sorting pipelines runs based on the field name

Enum:"run_number""-run_number""status""-status""pipeline__name""-pipeline__name""started_at""-started_at""ended_at""-ended_at"
cURL
curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/runs/?status=pending&pipeline_name=string&ordering=run_number' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

All Runs for the Pipelines in the Enterprise

Bodyapplication/json
codeinteger
messagestring
contentobject
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}