Fetch sync run

GET

sync_runs

{sync_run_id}

curl --request GET \
  --url https://app.getcensus.com/api/v1/sync_runs/{sync_run_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": 94,
    "sync_id": 52,
    "source_record_count": 15,
    "source_record_updates": 12,
    "source_record_deletes": 2,
    "source_record_invalids": 1,
    "records_processed": 14,
    "records_updated": 13,
    "records_failed": 1,
    "created_at": "2021-10-20T02:51:07.546Z",
    "updated_at": "2021-10-20T02:52:29.236Z",
    "completed_at": "2021-10-20T02:52:29.234Z",
    "scheduled_execution_time": "2021-10-20T02:52:29.234Z",
    "error_code": "JSON_ARRAY_ERROR",
    "error_message": "The array field being used does not appear to be valid JSON...",
    "error_detail": "Please make sure the field \"custom_field:Users\" with value \"jim\" is formatted as a JSON Array...",
    "status": "completed",
    "canceled": false,
    "full_sync": true,
    "current_step": "Running Sync"
  }
}

Authorizations

Authorization

string

header

required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

sync_run_id

integer

required

ID of the sync run

Response

200

application/json

Successfully retrieved sync run details.

status

enum<string>

required

The outcome of the fetch request

Available options:

success

Example:

"success"

data

object

required

data.id

integer

ID of this sync run.

Example:

94

data.sync_id

integer

ID of the sync.

Example:

52

data.source_record_count

integer | null

The number of records in the source object at the time of the sync run.

Example:

15

data.source_record_updates

integer | null

The number of new or updated records found in the source.

Example:

12

data.source_record_deletes

integer | null

The number of records deleted in the source.

Example:

2

data.source_record_invalids

integer | null

Number of source records skipped by Census because of data quality issues.

Example:

1

data.records_processed

integer | null

Number of records sent to the destination.

Example:

14

data.records_updated

integer | null

Number of records successfully sent to the destination.

Example:

13

data.records_failed

integer | null

Number of records rejected by the destination.

Example:

1

data.created_at

string

When this sync run was created.

Example:

"2021-10-20T02:51:07.546Z"

data.updated_at

string

When this sync run was updated.

Example:

"2021-10-20T02:52:29.236Z"

data.completed_at

string | null

When this sync run was completed.

Example:

"2021-10-20T02:52:29.234Z"

data.scheduled_execution_time

string | null

When the sync run was scheduled to run.

Example:

"2021-10-20T02:52:29.234Z"

data.error_code

string | null

The error code, if any.

Example:

"JSON_ARRAY_ERROR"

data.error_message

string | null

The error message, if any.

Example:

"The array field being used does not appear to be valid JSON..."

data.error_detail

string | null

Details about the error, if any.

Example:

"Please make sure the field \"custom_field:Users\" with value \"jim\" is formatted as a JSON Array..."

data.status

enum<string>

Status of the sync run. Possible values are:

working: The sync is currently executing.
completed: The sync finished successfully.
failed: The sync failed during execution.
skipped: An earlier instance of the sync is still running, so this run was skipped.
queued: The sync run is queued for execution.

Available options:

working,

completed,

failed,

skipped,

queued

Example:

"completed"

data.canceled

boolean

Whether or not this sync run was canceled.

Example:

false

data.full_sync

object

Whether or not this was a full sync.

data.current_step

enum<string>

The current step of the sync run. Available if the sync is running.

Available options:

Checking for columns to remove from the sync,

Checking for fields to create in destination,

Checking source and destination configuration,

Unloading data from warehouse,

Loading data into destination service,

Committing data to destination service,

Committing sync to warehouse,

Running sync

Example:

"Running Sync"

Was this page helpful?

Raise issue

List sync runs Cancel a running sync

curl --request GET \
  --url https://app.getcensus.com/api/v1/sync_runs/{sync_run_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": 94,
    "sync_id": 52,
    "source_record_count": 15,
    "source_record_updates": 12,
    "source_record_deletes": 2,
    "source_record_invalids": 1,
    "records_processed": 14,
    "records_updated": 13,
    "records_failed": 1,
    "created_at": "2021-10-20T02:51:07.546Z",
    "updated_at": "2021-10-20T02:52:29.236Z",
    "completed_at": "2021-10-20T02:52:29.234Z",
    "scheduled_execution_time": "2021-10-20T02:52:29.234Z",
    "error_code": "JSON_ARRAY_ERROR",
    "error_message": "The array field being used does not appear to be valid JSON...",
    "error_detail": "Please make sure the field \"custom_field:Users\" with value \"jim\" is formatted as a JSON Array...",
    "status": "completed",
    "canceled": false,
    "full_sync": true,
    "current_step": "Running Sync"
  }
}

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response