Get Replication Position of a Pipeline

Retrieves the replication position of each active object in the specified pipeline_id. Each object replicates independently, so a Pipeline has no single overall position. The response lists the objects in the ACTIVE status and those that are being reset. A selected object in the BLOCKED or INCONSISTENT status is not listed. The offset identifies the last point in your Source that Hevo has replicated for an object. Hevo returns the value as it reads it from your Source, and you cannot use it to restart replication from that point. Its format depends on the Source type:

  • PostgreSQL, MySQL and Oracle return the UTC time of the last change that Hevo replicated, such as Aug 27, 2026 13:05 UTC for PostgreSQL and Aug 27, 2026, 13:05 UTC for MySQL and Oracle.
  • SQL Server returns the commit and change log sequence numbers, such as Commit LSN: 00000034:00000158:0004, Change LSN: 00000034:00000158:0003.
  • PostgreSQL in XMIN mode returns the xmin value on its own.
  • A SaaS Source returns the keys that it tracks and their values, such as updated_at:1756833130123.

A value of - means that Hevo has not read a change for the object yet.

Hevo returns null as the position of an object that it has not ingested yet, and for every object in the response if the position is temporarily unavailable. The request still succeeds in both cases, so retry later. The response returns an empty list until Hevo reads the objects from your Source.

Refer to Tracking Replication Progress for more information about how replication progress is tracked.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Unique identifier of the Pipeline.

Query Params
string

Value used to retrieve the next set of results. Provide the next_cursor value returned in the previous API response. The cursor is valid only for the position list of the same Pipeline. Send back the next_cursor value exactly as you received it.

integer
1 to 500
Defaults to 100

Maximum number of results the API should return. If not set, the API returns up to 100 items.

Responses

400

The replication positions could not be retrieved. This occurs when:

  • The limit value is not an integer, or is outside the range of 1 to 500.
  • The cursor value cannot be decoded. A cursor that decodes but was never issued by this endpoint is not rejected, and can return an unexpected part of the list.
404

The Pipeline could not be found. This occurs when:

  • No Pipeline exists with the specified pipeline_id, or you do not have access to it.
  • The Pipeline is deleted, or its deletion is in progress.
  • The Pipeline is in a different region from the base URL that you call.
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json