Fetch test sync run status
Retrieves the status for test sync run and the sample record sent.
Request schema
Query parameters
sync_run_id
integerrequired
ID of the test sync run to check status for
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Http + 1.1
GET
https://app.getcensus.com/api/v1/syncs/test_status
GET /api/v1/syncs/test_status?sync_run_id=1234567890 HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Host: app.getcensus.com
Responses
200
Test sync run status retrieved successfully.
200
status
stringrequired
The outcome of the fetch request
enum:
data
objectrequired
id
integer
ID of this sync run.
example:
created_at
string
When this sync run was created.
format:
example:
updated_at
string
When this sync run was updated.
format:
example:
completed_at
string | null
When this sync run was completed.
format:
example:
error_code
string | null
The error code, if any.
example:
error_message
string | null
The error message, if any.
example:
error_detail
string | null
Details about the error, if any.
example:
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:
sample_record
object
A JSON representation of the record payload that was attempted to be sent to the destination. Present if the sync has completed or failed.
example:
sample_record_failed
boolean
Whether sending the sample record failed. Present if the sync has completed or failed.
current_step
string
The current step of the sync run, if not completed.
enum:
{ "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", "sample_record": { "ID": "id_1234", "NAME": "Hello World" }, "sample_record_failed": false, "current_step": "Prepare Sync" } }