Sync Runs

Fetch sample skipped records

Use this endpoint to retrieve a sample of skipped records for a specific sync run. The endpoint will redirect to a temporary S3 URL where the JSON file contents can be accessed. Clients should follow the redirect to retrieve the JSON data.

This is initially a 302 redirect to the skipped records file, and if followed ultimately returns a 200 with the JSON data in the response. The schema of the return will vary depending on the fields used in the sync. The sync key will be used to identify a record with an error_message. Additional properties will be returned matching the fields used in the sync.

The endpoint may also return a 410 if the skipped records file is no longer available. You can read more about how we handle skipped records and our policy on expiration: here.

GET

sync_runs

{sync_run_id}

sample_skipped_records

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

{
  "error_message": "<string>",
  ...your_record_attributes
}

{
  "error_message": "<string>",
  ...your_record_attributes
}

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

Query Parameters

type

enum<string>

default:invalid

The type of skipped records to retrieve (invalid from source or rejected from destination).

Available options:

invalid,

rejected

Response

200

application/json

This is initially a 302 redirect to the skipped records file. But this should ultimately be a 200. The schema of the return will vary depending on the fields you use in in your sync. The sync key will be used to identify your record with an `error_message`. Additional properties will be returned matching the fields used in your sync.

error_message

string

required

The reason why the record was skipped

Was this page helpful?

Raise issue

Cancel a running sync Fetch Records

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

{
  "error_message": "<string>",
  ...your_record_attributes
}

Introduction

Organization APIs

Workspace APIs

Fetch sample skipped records

Authorizations

Path Parameters

Query Parameters

Response