Skip to content
/BI View Tasks

BI View Tasks

Monitor and cancel the background tasks that prepare BI View pages.

Operations

List BI View tasks

Request

Returns the tenant's background BI View tasks grouped into active, completed, stale and draining.

Purpose: See which extractions are running before you start another one (each tenant has a query quota), and find stuck tasks to cancel.

Notes:

  • A task is stale when it has reported no progress for 240 seconds (tenant-configurable).
Security
OneIdOAuth
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 GET \
  https://one.zuora.com/api/integration/v2/biviews-status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

Tasks grouped by state.

Bodyapplication/json
activeArray of objects(BiViewTask)

Tasks that are running and reported progress recently.

completedArray of objects(BiViewTask)

Tasks that finished (COMPLETED, CANCELLED or FAILED).

staleArray of objects(BiViewTask)

Running tasks with no progress within the staleness threshold (240 seconds by default).

drainingArray of strings

Identifiers of tasks whose details have expired and are being removed.

Response
{
  "active": [
    { … }
  ],
  "completed": [],
  "stale": [],
  "draining": []
}