Retrieve Connection Sync History

Returns a list of sync history records for the specified connection. The maximum time window is 7 days.

Request schema

Path parameters

connectionId

stringrequired

The unique identifier of the connection. Retrieve it from the id field in the List All Connections response, or from the id field returned when you Create a Connection.

example:

4107c213907114059a5544ad8fa66c52

Query parameters

duration

integer

Deprecated. Use start_time and end_time instead.

format:

int32

start_time

string

The start of the time range for which to retrieve sync history, in ISO 8601 format (for example, 2026-01-01T00:00:00Z). If omitted, defaults to one hour before end_time. The maximum allowed range between start_time and end_time is 7 days.

end_time

string

The end of the time range for which to retrieve sync history, in ISO 8601 format (for example, 2026-01-01T01:00:00Z). If omitted, defaults to one hour after start_time. Must be after start_time.

cursor

string

Paging cursor, read more about pagination

example:

cursor_value

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json;version=2

example:

application/json;version=2

Http + 1.1

GET

https://api.fivetran.com/v1/connections/4107c213907114059a5544ad8fa66c52/sync-history

GET /v1/connections/4107c213907114059a5544ad8fa66c52/sync-history?duration=SOME_INTEGER_VALUE&start_time=SOME_STRING_VALUE&end_time=SOME_STRING_VALUE&cursor=cursor_value&limit=100 HTTP/1.1
Accept: application/json;version=2
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

400

Bad request error. Returned when the duration between `start_time` and `end_time` exceeds 7 days, `start_time` is after `end_time`, or `start_time` is more than 7 days in the past.

401

Unauthorized error

404

Not found error

405

Method not allowed error

406

Not acceptable error

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed successfully

data

undefinedrequired

items

arrayrequired

The collection of returned items

start

string

The UTC timestamp of when the sync started, in ISO 8601 format. Null if the sync has not started yet.

end

string

The UTC timestamp of when the sync finished, in ISO 8601 format. Null if the sync is still in progress.

status

stringrequired

The outcome of the sync. Possible values: COMPLETED, FAILURE, CANCELED, INCOMPLETE, RESCHEDULED, PAUSED.

reason

string

The failure reason if the sync did not complete successfully. Omitted if the sync completed without errors.

stages

objectrequired

The data volume processed in each stage of the sync pipeline.

extract

object

Data volume metrics for the extract stage, in which data is read from the source system.

volume

number

The volume of data processed in this stage, in megabytes. Null if volume data is not available for this stage.

format:

double

process

object

Data volume metrics for the process stage, in which data is transformed and prepared for loading.

volume

number

The volume of data processed in this stage, in megabytes. Null if volume data is not available for this stage.

format:

double

load

object

Data volume metrics for the load stage, in which data is written to the destination.

volume

number

The volume of data processed in this stage, in megabytes. Null if volume data is not available for this stage.

format:

double

sync_id

stringrequired

The unique identifier of the sync.

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Operation performed successfully",
  "data": {
    "items": [
      {
        "start": "string",
        "end": "string",
        "status": "string",
        "reason": "string",
        "stages": {
          "extract": {
            "volume": 0.1
          },
          "process": {
            "volume": 0.1
          },
          "load": {
            "volume": 0.1
          }
        },
        "sync_id": "string"
      }
    ],
    "next_cursor": "cursor_value"
  }
}