Skip to main content

Get burst variant batch

GET https://api.rollstack.com/public/v1/bursts/{id}/variants/batches/{batchId}

A batch of variants being added to a burst, with where each variant stands: copied from the template report, then run once to fetch its data. Waits up to waitSeconds for the batch to end and answers as soon as it does, so call it again while the status is running. Your later batch on the burst reuses the id, so this describes the latest one.

Requires the slide_decks:read scope.

Operation ID: getBurstVariantBatch.

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/.
  • batchId (string, required): The batch, by the batchId that addBurstVariants returned. A member's batches on a burst share one id, so it always refers to their latest.

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, the export on getRunsExport. 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

  • batchId (string, required): Identifies the batch, as returned by addBurstVariants.
  • status (string, required): Where the batch stands. It stays running until every variant in it is added and has run once, then says how it ended.

    • running: variants are still being added. Call getBurstVariantBatch again to keep waiting.
    • completed: the batch finished. Each of variants says how it went; find the added ones among the burst's variants in listBurstVariants.
    • failed: every variant failed, or the batch stopped on an error. A variant fails both when it can't be added and when it is added but its first run fails, so some may still be among the burst's variants in listBurstVariants.
    • cancelled: the batch was stopped in the app before it finished.

    One of running, completed, failed, cancelled.

  • startedAt (string (date-time), required): When the batch started.
  • finishedAt (string (date-time) or null, required): When the batch ended, whatever its outcome. null while it is running.
  • variants (array of object, required): The variants in the batch, in the order they were sent, each with where adding it stands.
    • name (string, required): The name the variant is added with, as addBurstVariants returned it.
    • status (string, required): Where adding it stands. queued: it waits for the variants before it. running: its report is being copied from the template and run for the first time. completed: it is among the burst's variants in listBurstVariants, though its first run may have only partly completed, as its lastRunStatus says. failed: either it could not be added, or its report was added but its first run failed. Look for it in listBurstVariants to tell which. cancelled: it was cancelled in the app, before it was added or during its first run. Its report may still be among the burst's variants. One of queued, running, completed, failed, cancelled.
    • error (string or null, required): Why the variant failed, when that is known, while status is failed. null otherwise, including when its report was added and only its first run failed.