Fetch sync run

Retrieve the details of a particular sync run

Request schema

Path parameters

sync_run_id

integerrequired

ID of the sync run

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/sync_runs/{sync_run_id}

GET /api/v1/sync_runs/{sync_run_id} HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved sync run details.

404

Resource not found.

`200`

status

stringrequired

The outcome of the fetch request

enum:

"success"

data

objectrequired

integer

ID of this sync run.

example:

created_at

string

When this sync run was created.

format:

date-time

example:

2021-10-20T02:51:07.546Z

updated_at

string

When this sync run was updated.

format:

date-time

example:

2021-10-20T02:52:29.236Z

completed_at

string | null

When this sync run was completed.

format:

date-time

example:

2021-10-20T02:52:29.234Z

error_code

string | null

The error code, if any.

example:

JSON_ARRAY_ERROR

error_message

string | null

The error message, if any.

example:

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

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...

status

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.

enum:

"working""completed""failed""skipped""queued"

sync_id

integer

ID of the sync.

example:

source_record_count

integer | null

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

example:

records_failed

integer | null

Number of records rejected by the destination.

example:

source_record_updates

integer | null

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

example:

source_record_deletes

integer | null

The number of records deleted in the source.

example:

source_record_invalids

integer | null

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

example:

records_invalid

integer | null

Number of source records skipped by Census because of data quality issues (backward compatibility).

example:

records_processed

integer | null

Number of records sent to the destination.

example:

records_updated

integer | null

Number of records successfully sent to the destination.

example:

scheduled_execution_time

string | null

When the sync run was scheduled to run.

format:

date-time

example:

2021-10-20T02:52:29.234Z

full_sync

boolean

Whether or not this was a full sync.

example:

true

sync_trigger_reason

object

ui_tag

string

A short human-readable description of the trigger for this sync run

example:

Manual

ui_detail

string

A longer human-readable description of the trigger for this sync run. For example, including the email of the user that triggered it

example:

Manually triggered by test@getcensus.com

canceled

boolean

Whether or not this sync run was canceled.

current_step

string

The current step of the sync run. Available if the sync is not completed.

enum:

"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"

`404`

status

integer

HTTP status code.

enum:

"404"

{
  "status": "success",
  "data": {
    "id": 94,
    "created_at": "2021-10-20T02:51:07.546Z",
    "updated_at": "2021-10-20T02:52:29.236Z",
    "completed_at": "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",
    "sync_id": 52,
    "source_record_count": 15,
    "records_failed": 1,
    "source_record_updates": 12,
    "source_record_deletes": 2,
    "source_record_invalids": 1,
    "records_invalid": 1,
    "records_processed": 14,
    "records_updated": 13,
    "scheduled_execution_time": "2021-10-20T02:52:29.234Z",
    "full_sync": true,
    "sync_trigger_reason": {
      "ui_tag": "Manual",
      "ui_detail": "Manually triggered by test@getcensus.com"
    },
    "canceled": false,
    "current_step": "Running Sync"
  }
}