Skip to main content
GET
List the Cube placements in an external spreadsheet
Every block of Cube-written cells in the external document externalWorkbookId — a Google Drive file id, or the custom property the Excel add-in writes — across the whole tenant. Unlike GET /api/v1/deployments/{deploymentId}/reports?externalWorkbookId=, which lists only the reports the caller can read, this endpoint also reports the placements they cannot: each entry carries access, which is GRANTED when the caller may open the exploration and DENIED when they may not. It is how a recipient of a shared workbook learns that a block they are looking at is backed by an exploration nobody has shared with them, and who to ask. A DENIED entry carries only the placement’s address (resultLocation/sheetId/sheetName/anchorCell/endResultCell/host), its opaque reportId/placementId, the owning deploymentId, the placement’s placedAt/refreshedAt timestamps, and the exploration’s owner — including their email address, so the recipient can ask for access. owner is null for an embed-partition exploration whose owning user record no longer exists — embed report ownership carries no foreign key, so the row can outlive its owner; a main-workspace exploration’s owner always exists, since deleting the owner cascades to delete the report. reportName is null on a denied entry — the name is withheld along with the exploration — and reading the report itself still answers 403. Results are returned in pages using cursor-based pagination: pass first to set the page size and after (the previous response’s pageInfo.endCursor) to fetch the next page. Omitting first returns every placement in the document. A document holding more than 500 placed explorations, or more than 2000 placements in total, is answered with 422 rather than a truncated page — an inventory that looks complete but is not would hide the very placement a recipient needs to see.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

externalWorkbookId
string
required

Query Parameters

after
string | null
first
integer | null
Required range: x >= 1

Response

items
object[]
required
pageInfo
object | null