Skip to main content
GET
One preview: where it stands, what it would create and what would fail

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string<uuid>
required
syncid
string<uuid>
required
preview_id
string<uuid>
required

Query Parameters

language
string | null

ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

Response

Successful Response

preview_id
string<uuid>
required

The preview's id.

status
enum<string>
required

Pending while it is queued or running, then ready or failed.

Available options:
pending,
ready,
failed
started_at
string<date-time>
required

When it was asked for.

finished_at
string<date-time> | null
required

When it ended. Null until it does.

error
string | null
required

Why it failed. Null unless it did.

counts
PreviewCount · object[]
required

How many objects of each kind it would create.

issues
PreviewIssue · object[]
required

What would fail, one entry per cause; a missing mapping, one entry per table.

refill_suggested
boolean
required

Mappings are missing: POST …/ai-fill may fill them, then preview again.