Skip to content
Revenue API
/
/
Cancel a BI View task

Cancel a BI View task

Request

Stops a background BI View task and marks it CANCELLED. Pages already written can no longer be relied on.

Purpose: Free your tenant's query quota when an extraction was started by mistake or is stuck.

Notes:

  • The stop request is sent even when the task details have expired; in that case the response is 204.
Security
OneIdOAuth
Path
task_idstringrequired

Task identifier (the continuation-token value).

Example:3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4
Headers
Zuora-Track-Idstring

Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.

Example:close-run-2026-09-001
cURL
curl -i -X DELETE \
  https://one.zuora.com/api/integration/v2/biviews-status/3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

The task was cancelled. Returns its final state.

Bodyapplication/json
task_idstring

Task identifier (same value as the continuation-token).

Example:"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4"
statusstring

Task status. ADDED-TO-QUEUE, META-DATA-SCANNED, SCANNING-PAGE-n, COMMITING-PAGE-n, MAX-REQUESTED-PAGE-REACHED, NO-RECORD-FOUND and END-OF-QUERY-DATA are in-progress states; COMPLETED, CANCELLED and FAILED are final.

Example:"COMMITING-PAGE-3"
messagestring or null

Latest progress or error message.

metricinteger or null

Rows written by the latest step.

Example:1000
accumulateinteger or null

Total rows written so far.

Example:3000
query_configobject(BiViewTaskQueryConfig)

View and date range being queried.

activity_trackerobject(BiViewTaskTime)

Timing information.

Response
{
  "task_id": "3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4",
  "status": "CANCELLED",
  "message": null,
  "metric": 1000,
  "accumulate": 4000,
  "query_config": {
    "object_name": "RPRO_BI3_RC_LNS_V",
    "filter_params": { … }
  },
  "activity_tracker": {
    "initated_time": "2026-10-09T07:20:01.512000",
    "last_activity": "2026-10-09T07:23:00.101000",
    "elapsed_time": "0:00:00.004000"
  }
}