Skip to main content
GET
/
pipeline-runs
/
delta
Compare two pipeline runs (delta)
curl --request GET \
  --url https://api.sftpsync.io/pipeline-runs/delta \
  --header 'x-api-key: <api-key>'
{
  "baseRunId": "<string>",
  "compareRunId": "<string>",
  "pipelineId": "<string>",
  "summary": {
    "baseCount": 123,
    "compareCount": 123,
    "addedCount": 123,
    "removedCount": 123
  },
  "changes": [
    {
      "record": {}
    }
  ],
  "pagination": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "returned": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
baseRunId
string
required

Baseline (earlier) pipeline run id — the "before" side.

​
compareRunId
string
required

Comparison (later) pipeline run id — the "after" side. Must belong to the same pipeline as baseRunId.

​
offset
integer
default:0

Offset into the flattened changes list.

Required range: x >= 0
​
limit
integer
default:100

Maximum number of change entries to return (1–1000).

Required range: 1 <= x <= 1000

Response

The delta between the two runs.

Record-level delta between two runs of the same pipeline.

​
baseRunId
string
required
​
compareRunId
string
required
​
pipelineId
string
required

The pipeline definition both runs belong to.

​
summary
object
required

Aggregate counts for a pipeline-run delta.

​
changes
object[]
required

Changed records for this page (added first, then removed).

​
pagination
object
required

Pagination metadata for the flattened changes list.