List the Cube placements in an external spreadsheet
curl --request GET \
--url https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"access": "GRANTED",
"deploymentId": 123,
"reportId": 123,
"resultLocation": "<string>",
"anchorCell": "<string>",
"endResultCell": "<string>",
"host": "GOOGLE_SHEETS",
"owner": {
"email": "<string>",
"id": 123,
"firstName": "<string>",
"picture": "<string>"
},
"placedAt": "<string>",
"placementId": "<string>",
"refreshedAt": "<string>",
"reportName": "<string>",
"sheetId": "<string>",
"sheetName": "<string>"
}
],
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"endCursor": "<string>",
"startCursor": "<string>"
}
}External Documents
List the Cube placements in an external spreadsheet
GET
/
api
/
v1
/
external-documents
/
{externalWorkbookId}
/
placements
List the Cube placements in an external spreadsheet
curl --request GET \
--url https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/external-documents/{externalWorkbookId}/placements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"access": "GRANTED",
"deploymentId": 123,
"reportId": 123,
"resultLocation": "<string>",
"anchorCell": "<string>",
"endResultCell": "<string>",
"host": "GOOGLE_SHEETS",
"owner": {
"email": "<string>",
"id": 123,
"firstName": "<string>",
"picture": "<string>"
},
"placedAt": "<string>",
"placementId": "<string>",
"refreshedAt": "<string>",
"reportName": "<string>",
"sheetId": "<string>",
"sheetName": "<string>"
}
],
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"endCursor": "<string>",
"startCursor": "<string>"
}
}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
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.