v4

latestSwagger 2.02026-08-0343714211.7 MB

sync_logs

Sync Logs

List Sync Logs

get/sync_logs

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 1000, 1,000 or less is recommended).

If set, return records where the specified field is equal to the supplied value. Valid fields are external_event_id, operation, status, sync_id, created_at or sync_run_id. Valid field combinations are [ external_event_id ], [ operation ], [ status ], [ sync_id ], [ created_at ], [ sync_run_id ], [ external_event_id, operation ], [ external_event_id, status ], [ external_event_id, sync_id ], [ external_event_id, created_at ], [ external_event_id, sync_run_id ], [ operation, status ], [ operation, sync_id ], [ operation, created_at ], [ operation, sync_run_id ], [ status, sync_id ], [ status, created_at ], [ status, sync_run_id ], [ sync_id, created_at ], [ sync_id, sync_run_id ], [ created_at, sync_run_id ], [ external_event_id, operation, status ], [ external_event_id, operation, sync_id ], [ external_event_id, operation, created_at ], [ external_event_id, operation, sync_run_id ], [ external_event_id, status, sync_id ], [ external_event_id, status, created_at ], [ external_event_id, status, sync_run_id ], [ external_event_id, sync_id, created_at ], [ external_event_id, sync_id, sync_run_id ], [ external_event_id, created_at, sync_run_id ], [ operation, status, sync_id ], [ operation, status, created_at ], [ operation, status, sync_run_id ], [ operation, sync_id, created_at ], [ operation, sync_id, sync_run_id ], [ operation, created_at, sync_run_id ], [ status, sync_id, created_at ], [ status, sync_id, sync_run_id ], [ status, created_at, sync_run_id ], [ sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id ], [ external_event_id, operation, status, created_at ], [ external_event_id, operation, status, sync_run_id ], [ external_event_id, operation, sync_id, created_at ], [ external_event_id, operation, sync_id, sync_run_id ], [ external_event_id, operation, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at ], [ external_event_id, status, sync_id, sync_run_id ], [ external_event_id, status, created_at, sync_run_id ], [ external_event_id, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at ], [ operation, status, sync_id, sync_run_id ], [ operation, status, created_at, sync_run_id ], [ operation, sync_id, created_at, sync_run_id ], [ status, sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id, created_at ], [ external_event_id, operation, status, sync_id, sync_run_id ], [ external_event_id, operation, status, created_at, sync_run_id ], [ external_event_id, operation, sync_id, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at, sync_run_id ] or [ external_event_id, operation, status, sync_id, created_at, sync_run_id ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at. Valid field combinations are [ external_event_id ], [ operation ], [ status ], [ sync_id ], [ created_at ], [ sync_run_id ], [ external_event_id, operation ], [ external_event_id, status ], [ external_event_id, sync_id ], [ external_event_id, created_at ], [ external_event_id, sync_run_id ], [ operation, status ], [ operation, sync_id ], [ operation, created_at ], [ operation, sync_run_id ], [ status, sync_id ], [ status, created_at ], [ status, sync_run_id ], [ sync_id, created_at ], [ sync_id, sync_run_id ], [ created_at, sync_run_id ], [ external_event_id, operation, status ], [ external_event_id, operation, sync_id ], [ external_event_id, operation, created_at ], [ external_event_id, operation, sync_run_id ], [ external_event_id, status, sync_id ], [ external_event_id, status, created_at ], [ external_event_id, status, sync_run_id ], [ external_event_id, sync_id, created_at ], [ external_event_id, sync_id, sync_run_id ], [ external_event_id, created_at, sync_run_id ], [ operation, status, sync_id ], [ operation, status, created_at ], [ operation, status, sync_run_id ], [ operation, sync_id, created_at ], [ operation, sync_id, sync_run_id ], [ operation, created_at, sync_run_id ], [ status, sync_id, created_at ], [ status, sync_id, sync_run_id ], [ status, created_at, sync_run_id ], [ sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id ], [ external_event_id, operation, status, created_at ], [ external_event_id, operation, status, sync_run_id ], [ external_event_id, operation, sync_id, created_at ], [ external_event_id, operation, sync_id, sync_run_id ], [ external_event_id, operation, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at ], [ external_event_id, status, sync_id, sync_run_id ], [ external_event_id, status, created_at, sync_run_id ], [ external_event_id, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at ], [ operation, status, sync_id, sync_run_id ], [ operation, status, created_at, sync_run_id ], [ operation, sync_id, created_at, sync_run_id ], [ status, sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id, created_at ], [ external_event_id, operation, status, sync_id, sync_run_id ], [ external_event_id, operation, status, created_at, sync_run_id ], [ external_event_id, operation, sync_id, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at, sync_run_id ] or [ external_event_id, operation, status, sync_id, created_at, sync_run_id ].

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at. Valid field combinations are [ external_event_id ], [ operation ], [ status ], [ sync_id ], [ created_at ], [ sync_run_id ], [ external_event_id, operation ], [ external_event_id, status ], [ external_event_id, sync_id ], [ external_event_id, created_at ], [ external_event_id, sync_run_id ], [ operation, status ], [ operation, sync_id ], [ operation, created_at ], [ operation, sync_run_id ], [ status, sync_id ], [ status, created_at ], [ status, sync_run_id ], [ sync_id, created_at ], [ sync_id, sync_run_id ], [ created_at, sync_run_id ], [ external_event_id, operation, status ], [ external_event_id, operation, sync_id ], [ external_event_id, operation, created_at ], [ external_event_id, operation, sync_run_id ], [ external_event_id, status, sync_id ], [ external_event_id, status, created_at ], [ external_event_id, status, sync_run_id ], [ external_event_id, sync_id, created_at ], [ external_event_id, sync_id, sync_run_id ], [ external_event_id, created_at, sync_run_id ], [ operation, status, sync_id ], [ operation, status, created_at ], [ operation, status, sync_run_id ], [ operation, sync_id, created_at ], [ operation, sync_id, sync_run_id ], [ operation, created_at, sync_run_id ], [ status, sync_id, created_at ], [ status, sync_id, sync_run_id ], [ status, created_at, sync_run_id ], [ sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id ], [ external_event_id, operation, status, created_at ], [ external_event_id, operation, status, sync_run_id ], [ external_event_id, operation, sync_id, created_at ], [ external_event_id, operation, sync_id, sync_run_id ], [ external_event_id, operation, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at ], [ external_event_id, status, sync_id, sync_run_id ], [ external_event_id, status, created_at, sync_run_id ], [ external_event_id, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at ], [ operation, status, sync_id, sync_run_id ], [ operation, status, created_at, sync_run_id ], [ operation, sync_id, created_at, sync_run_id ], [ status, sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id, created_at ], [ external_event_id, operation, status, sync_id, sync_run_id ], [ external_event_id, operation, status, created_at, sync_run_id ], [ external_event_id, operation, sync_id, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at, sync_run_id ] or [ external_event_id, operation, status, sync_id, created_at, sync_run_id ].

If set, return records where the specified field is less than the supplied value. Valid fields are created_at. Valid field combinations are [ external_event_id ], [ operation ], [ status ], [ sync_id ], [ created_at ], [ sync_run_id ], [ external_event_id, operation ], [ external_event_id, status ], [ external_event_id, sync_id ], [ external_event_id, created_at ], [ external_event_id, sync_run_id ], [ operation, status ], [ operation, sync_id ], [ operation, created_at ], [ operation, sync_run_id ], [ status, sync_id ], [ status, created_at ], [ status, sync_run_id ], [ sync_id, created_at ], [ sync_id, sync_run_id ], [ created_at, sync_run_id ], [ external_event_id, operation, status ], [ external_event_id, operation, sync_id ], [ external_event_id, operation, created_at ], [ external_event_id, operation, sync_run_id ], [ external_event_id, status, sync_id ], [ external_event_id, status, created_at ], [ external_event_id, status, sync_run_id ], [ external_event_id, sync_id, created_at ], [ external_event_id, sync_id, sync_run_id ], [ external_event_id, created_at, sync_run_id ], [ operation, status, sync_id ], [ operation, status, created_at ], [ operation, status, sync_run_id ], [ operation, sync_id, created_at ], [ operation, sync_id, sync_run_id ], [ operation, created_at, sync_run_id ], [ status, sync_id, created_at ], [ status, sync_id, sync_run_id ], [ status, created_at, sync_run_id ], [ sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id ], [ external_event_id, operation, status, created_at ], [ external_event_id, operation, status, sync_run_id ], [ external_event_id, operation, sync_id, created_at ], [ external_event_id, operation, sync_id, sync_run_id ], [ external_event_id, operation, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at ], [ external_event_id, status, sync_id, sync_run_id ], [ external_event_id, status, created_at, sync_run_id ], [ external_event_id, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at ], [ operation, status, sync_id, sync_run_id ], [ operation, status, created_at, sync_run_id ], [ operation, sync_id, created_at, sync_run_id ], [ status, sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id, created_at ], [ external_event_id, operation, status, sync_id, sync_run_id ], [ external_event_id, operation, status, created_at, sync_run_id ], [ external_event_id, operation, sync_id, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at, sync_run_id ] or [ external_event_id, operation, status, sync_id, created_at, sync_run_id ].

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at. Valid field combinations are [ external_event_id ], [ operation ], [ status ], [ sync_id ], [ created_at ], [ sync_run_id ], [ external_event_id, operation ], [ external_event_id, status ], [ external_event_id, sync_id ], [ external_event_id, created_at ], [ external_event_id, sync_run_id ], [ operation, status ], [ operation, sync_id ], [ operation, created_at ], [ operation, sync_run_id ], [ status, sync_id ], [ status, created_at ], [ status, sync_run_id ], [ sync_id, created_at ], [ sync_id, sync_run_id ], [ created_at, sync_run_id ], [ external_event_id, operation, status ], [ external_event_id, operation, sync_id ], [ external_event_id, operation, created_at ], [ external_event_id, operation, sync_run_id ], [ external_event_id, status, sync_id ], [ external_event_id, status, created_at ], [ external_event_id, status, sync_run_id ], [ external_event_id, sync_id, created_at ], [ external_event_id, sync_id, sync_run_id ], [ external_event_id, created_at, sync_run_id ], [ operation, status, sync_id ], [ operation, status, created_at ], [ operation, status, sync_run_id ], [ operation, sync_id, created_at ], [ operation, sync_id, sync_run_id ], [ operation, created_at, sync_run_id ], [ status, sync_id, created_at ], [ status, sync_id, sync_run_id ], [ status, created_at, sync_run_id ], [ sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id ], [ external_event_id, operation, status, created_at ], [ external_event_id, operation, status, sync_run_id ], [ external_event_id, operation, sync_id, created_at ], [ external_event_id, operation, sync_id, sync_run_id ], [ external_event_id, operation, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at ], [ external_event_id, status, sync_id, sync_run_id ], [ external_event_id, status, created_at, sync_run_id ], [ external_event_id, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at ], [ operation, status, sync_id, sync_run_id ], [ operation, status, created_at, sync_run_id ], [ operation, sync_id, created_at, sync_run_id ], [ status, sync_id, created_at, sync_run_id ], [ external_event_id, operation, status, sync_id, created_at ], [ external_event_id, operation, status, sync_id, sync_run_id ], [ external_event_id, operation, status, created_at, sync_run_id ], [ external_event_id, operation, sync_id, created_at, sync_run_id ], [ external_event_id, status, sync_id, created_at, sync_run_id ], [ operation, status, sync_id, created_at, sync_run_id ] or [ external_event_id, operation, status, sync_id, created_at, sync_run_id ].

Response

A list of SyncLogs objects.

timestampstring date-time

Start Time of Action. Deprecrated: Use created_at.

sync_idinteger

Sync ID

external_event_idinteger

External Event ID used by legacy syncs

sync_run_idinteger

Sync Run ID

error_typestring

Error type, if applicable

messagestring

Message

Operation type

pathstring

File path

sizeinteger

File size

file_typestring

File type

status'success' | 'failure' | 'partial_failure' | 'skipped' | 'retried_failure'

Status

created_atstring date-time

Start Time of Action

Example response

[
  {
    "timestamp": "2000-01-01T01:00:00Z",
    "sync_id": 1,
    "external_event_id": 1,
    "sync_run_id": 1,
    "error_type": "example",
    "message": "example",
    "operation": "example",
    "path": "example",
    "size": 1,
    "file_type": "example",
    "status": "success",
    "created_at": "2000-01-01T01:00:00Z"
  }
]