Skip to main content
POST
Export run test record

Path Parameters

runShortId
string
required

Body

application/json

Request body for exporting a run's test record.

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$
includeVideos
boolean

Include session recordings in the archive. Defaults to true. Recordings make the archive much larger.

Response

202 - application/json

The request has been accepted for processing, but processing has not yet completed.

A test record export of a run: one zip with a README in a regulatory test record layout, every test step and recorded action with screenshots and recordings, the raw logs and a manifest with the SHA-256 of every file.

id
string
required

Export ID. Pass it to get_run_export to poll.

runShortId
string
required

Short ID of the exported run.

status
enum<string>
required

pending and running while the archive is built; then completed or failed.

Available options:
pending,
running,
completed,
failed
includeVideos
boolean
required

Whether session recordings are included.

sizeBytes
integer<int64> | null
required

Size of the zip in bytes, once completed.

sha256
string | null
required

SHA-256 of the zip (hex), once completed. Verify the download against it.

fileCount
integer<int32> | null
required

Number of files in the zip, once completed.

error
string | null
required

Why the export failed, when status is failed.

createdAt
string
required

When the export was requested (ISO 8601).

completedAt
string | null
required

When the export finished (ISO 8601).

downloadUrl
string | null
required

Signed URL for the zip, valid for one hour. Minted on every request once completed; null otherwise.

downloadUrlExpiresAt
string | null
required

When downloadUrl stops working (ISO 8601).