Get Preview Run
Retrieve one of this template’s preview runs together with its per-device results.
A run is only readable under the template it previewed: under any other template it is a 404, the same as a run that does not exist.
thumbnail_url and screenshot_url are short-lived signed URLs, re-signed on every read. Fetch them now rather than storing them. Both are null until Courier’s own copy of the image exists, which is what status: COMPLETED on a result means.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Template ID (nt_ prefix).
The preview run to retrieve, identified by the id returned when it was created.
Response
A preview run together with its per-device results.
Unique identifier for the preview run.
The template that was rendered.
Where the run itself has got to. PENDING and RENDERED mean Courier is still preparing the email, SUBMITTED means it is with the rendering service, and COMPLETED means every device has reported. FAILED is the run as a whole failing — an individual device failing never fails the run.
PENDING, RENDERED, SUBMITTED, COMPLETED, FAILED The devices this run was submitted for, snapshotted when the run was created.
ISO-8601 timestamp of when the run was created.
One entry per device in device_ids.
The version of the template that was rendered — draft, or a zero-padded published version such as v002. Absent until the render settles.
Why the run failed, when status is FAILED. NO_EMAIL_CHANNEL and TEMPLATE_NOT_SUPPORTED mean there was nothing to render; ALL_DEVICES_UNSUPPORTED means every requested device has been retired and the request can be fixed by choosing others.
TEMPLATE_NOT_SUPPORTED, NO_EMAIL_CHANNEL, RENDER_FAILED, ALL_DEVICES_UNSUPPORTED, VENDOR_ERROR