Skip to main content

Cancel report run

POST https://api.rollstack.com/public/v1/reports/{id}/runs/{runId}/cancel

Cancels a run of a report, whoever started it. Only its editors may. A run that already ended stays as it is.

Requires the slide_decks:run scope.

Operation ID: cancelReportRun.

Path parameters

  • id (string, required): The report to act on, of any type, by its id from listReports or createReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after /slides/ or /destinations/.
  • runId (string, required): The run, by the runId that startReportRun returned. Runs of a report started by the same member share one id, so it always refers to that member's latest run of the report.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Response 204

Success, no content