Sign in
Swarm runs

Get a journey run

The full record, including per-session attempts and targetSummaries.

Read canceled before reporting a failure: a stopped run carries status: "failed".

get/projects/{projectId}/journey-runs/{runId}

Response

The run.

idstring required
projectIdstring required
journeyIdstring required
waveIdstring

The batch this run was launched with. Sibling runs of one co-launched wave share it; a solo relaunch is a wave of one. Absent on a run launched without one.

status'running' | 'completed' | 'partial' | 'failed' | 'rate_limited' required

Poll until it leaves running.

canceledboolean required

True when somebody STOPPED this run. Check this before showing a run as a failure: a cancelled run reports status: "failed", because cancellation is recorded as a marker rather than a status of its own.

staleboolean required

True when the runner went silent and the watchdog settled the run. Distinct from a run that failed while still reporting.

errorstring

Raw marker behind canceled / stale.

createdAtnumber required

Epoch milliseconds.

lastHeartbeatAtnumber

Epoch milliseconds of the runner's last check-in. A long-stale heartbeat on a running run is what the watchdog acts on.

Changes

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