latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

MonitoringWorkflow

List pipeline runs for a monitoring workflow

Returns a paginated list of pipeline execution records (CAQH or NPDB) for the specified monitoring workflow. Use this endpoint to inspect run history; use GET /monitoring-workflows/{workflowId}/pipeline-runs/{id} to fetch a single run's detail. Supports offset-based pagination (page/size, default page 0, size 50) and cursor-based pagination (cursor); supplying cursor switches to cursor-based pagination and overrides page/size. The filter parameter accepts a JSON object using the same operators as GET /monitoring-workflows (eq, neq, gt, gte, lt, lte, in, nin, contains), e.g. {"createdAt":{"gte":"2023-01-01T00:00:00Z"}}. The order parameter accepts a JSON sort specification, e.g. {"createdAt":"desc"}. When includeSteps is true, each run in the response includes its pipeline step breakdown; defaults to false when omitted. Requires MONITORING_WORKFLOW_PIPELINE_TRIGGER. The tenant-id header is mandatory. Returns 404 when the workflow does not exist or belongs to a different tenant.

get/monitoring-workflows/{workflowId}/pipeline-runs

Path parameters

workflowIdstring required

ID of the monitoring workflow

Query parameters

cursorstring

Cursor for cursor-based pagination. Supplying this switches to cursor-based pagination and takes precedence over page/size.

filterstring

Filter criteria as a JSON object mapping field paths to an operator (eq, neq, gt, gte, lt, lte, in, nin, contains). Example: {"createdAt":{"gte":"2023-01-01T00:00:00Z"}}

includeStepsboolean

Whether to include each run's pipeline step breakdown. Defaults to false when omitted.

orderstring

JSON sort specification. Example: {"createdAt":"desc"}

pageinteger

Page number (0-based) for offset-based pagination. Ignored if cursor is supplied.

sizeinteger

Page size (default 50) for either pagination mode.

Headers

tenant-idstring required

Tenant ID

Response

Pagination envelope: totalCount (total matching runs) and data (array of pipeline run records for the current page).

totalCountinteger

Total count of pipeline runs matching the filter criteria

Example response

{
  "totalCount": 100
}