Introduction
Organization APIs
- Users
- Invitations
- Workspaces
Workspace APIs
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- Source Connect Links
- Segment Management Links
- Webhooks
Sync Runs
Fetch sync run
Retrieve the details of a particular 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
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
ID of the sync run
Response
200
application/json
Successfully retrieved sync run details.
The response is of type object
.
Was this page helpful?
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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.