Skip to main content

Get burst run

GET https://api.rollstack.com/public/v1/bursts/{id}/runs

Where the runs of a burst's variants stand, such as those startBurstRun started, with how each variant's latest run ended. Waits up to waitSeconds for none of them to be running and answers as soon as that happens, so call it again while the status is running. A run started in the app or by a schedule counts too.

Requires the slide_decks:read scope.

Operation ID: getBurstRun.

Path parameters

  • id (string, required): The burst to act on, by its id from listBursts. You can also copy it from the burst's link in Rollstack: it's the part right after /collections/.

Query parameters

  • waitSeconds (integer): How long this call waits for the work to finish, in seconds: the message to the slides agent on getReportMessage, the run on getReportRun, the batch of variants being added on getBurstVariantBatch, the runs of a burst's variants on getBurstRun. It returns as soon as the work is done, or as things stand once the time is up, so call it again while status is still queued or running. 0 returns at once. Defaults to 20; at most 30. Defaults to 20.

Response 200

Success

application/json

  • status (string, required): Where the burst's run stands. running: some variants are still running; call getBurstRun again to keep waiting. completed: none is running, and each variant's lastRunStatus says how its latest run ended. One of running, completed.
  • variants (array of object, required): The burst's variants you can see, oldest first.
    • id (string, required): The variant's report id.
    • name (string, required): The variant's report name.
    • runId (string or null, required): The variant's run in progress, whoever started it. Pass it with the variant's id to getReportRun or cancelReportRun. null once the variant isn't running.
    • lastRunStatus (string or null, required): How the variant's latest run that ended went: completed, failed or cancelled, as lastRunStatus on the report says. null if it has never run. Check lastSyncedAt to tell whether that run is the one you started; listReportRuns says why a run failed. One of running, completed, failed, cancelled, timed_out.
    • lastSyncedAt (string (date-time) or null, required): When the variant's latest run ended, whatever its outcome. null if it has never run.