Get burst run
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
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 itsidfromlistBursts. 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 ongetReportMessage, the run ongetReportRun, the batch of variants being added ongetBurstVariantBatch, the runs of a burst's variants ongetBurstRun. It returns as soon as the work is done, or as things stand once the time is up, so call it again whilestatusis stillqueuedorrunning.0returns at once. Defaults to20; at most30. Defaults to20.
Response 200
Success
application/json
status(string, required): Where the burst's run stands.running: some variants are still running; callgetBurstRunagain to keep waiting.completed: none is running, and each variant'slastRunStatussays how its latest run ended. One ofrunning,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'sidtogetReportRunorcancelReportRun.nullonce the variant isn't running.lastRunStatus(string or null, required): How the variant's latest run that ended went:completed,failedorcancelled, aslastRunStatuson the report says.nullif it has never run. ChecklastSyncedAtto tell whether that run is the one you started;listReportRunssays why a run failed. One ofrunning,completed,failed,cancelled,timed_out.lastSyncedAt(string (date-time) or null, required): When the variant's latest run ended, whatever its outcome.nullif it has never run.