Sign in
Design Studio emails

Get an inbox preview job

Returns the status of a preview job submitted with Send for inbox previews, including each preview's settings.

get/v1/design_studio/emails/{id}/inbox_previews/{run_id}

Path parameters

idstring uuid required

The UUID of the email. If your email has translations, this is the ID of a specific language variant.

run_idinteger required

The ID of the inbox preview job, returned by Send for inbox previews.

Response

Successful response

run_idinteger

ID of the preview job.

namestring

The batch label provided when you sent an email for previews. Empty if none was given.

client_idsstring[]

The device identifiers requested for this job.

created_atinteger

When you submitted the preview job.

updated_atinteger

When the job's status was last updated.

is_processedboolean

true once every device has settled, for the email in the path—a multi-language run reports each of its emails separately, so this doesn't reflect the whole run when it covers more than one. Poll this field, and see the endpoint description for how often, and for when to give up.

total_previews_requestedinteger

Previews requested in the job, for the email in the path. On a settled run, this is normally total_previews_cached + total_previews_succeeded + total_previews_bounced.

total_previews_cachedinteger

Previews served from an earlier run's screenshot. Not charged, and not counted in total_previews_succeeded.

total_previews_succeededinteger

Previews this run generated itself, excluding cached ones. A fully cached run reports 0 here even though every tile is Complete—compare total_previews_ready against total_previews_requested instead to track progress.

total_previews_bouncedinteger

Previews that produced no screenshot, whether the vendor bounced them or they failed on Customer.io's side. Their credits are refunded when the run settles.

total_previews_readyinteger

How many previews show a screenshot you can fetch, counted from the tiles themselves. This is the progress count to compare against total_previews_requested—total_previews_succeeded alone reads 0 on a fully cached run. It isn't the completion signal; is_processed is. Because a tile can be served by an earlier screenshot of the same content while this run's own render is still in flight, this can reach total_previews_requested before the run finishes.

Changes

Changed in 1 of the 13 revisions of this API.1