Skip to content

Get pipeline runs

GET /api/v1/data-pipelines/runs/{runId}: request fields and declared response contract.

GET/api/v1/data-pipelines/runs/{runId}

Authorization
PermissiondataPipelines.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
runIdstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.idstringrequirednon-null—
data.companyIdstringrequirednon-null—
data.workspaceIdstringrequirednon-null—
data.pipelineIdstringrequirednon-null—
data.versionIdstringrequirednon-null—
data.sourceIdstringoptionalnon-null—
data.mode"dry_run" | "promote"requirednon-null—
data.trigger"manual" | "upload" | "schedule" | "webhook" | "api"requirednon-null—
data.status"queued" | "validating" | "running" | "completed" | "failed" | "partial_failure" | "cancelled"requirednon-null—
data.actorMemberIdstringrequirednon-null—
data.countsobjectrequirednon-null—
data.counts.rowsReadintegerrequirednon-null—
data.counts.rowsValidintegerrequirednon-null—
data.counts.rowsInvalidintegerrequirednon-null—
data.counts.entitiesResolvedintegerrequirednon-null—
data.counts.entitiesMintedintegerrequirednon-null—
data.counts.entitiesPromotedintegerrequirednon-null—
data.counts.sourceObjectsSeenintegeroptionalnon-null—
data.counts.sourceObjectsDroppedintegeroptionalnon-null—
data.counts.sourceExtractsDroppedintegeroptionalnon-null—
data.counts.sourceObjectsLandedintegeroptionalnon-null—
data.errorSummaryarrayrequirednon-null—
data.jobIdstringoptionalnon-null—
data.createdAtstringrequirednon-null—
data.startedAtstringoptionalnon-null—
data.completedAtstringoptionalnon-null—
data.artifactsarrayrequirednon-null—

Declared failures

Declared failures
DATA_PIPELINES_RUN_NOT_FOUND404 — not retryable

Readback

This method returns the current state it read.

  • dataPipelines.runs.get

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/data-pipelines/runs/{runId} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>