Create or update a report by publicId
curl --request PUT \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endResultCell": "<string>",
"externalWorkbookId": "<string>",
"folderId": 123,
"jsonQuery": "<string>",
"meta": {},
"name": "<string>",
"pivotItems": {
"columns": [
"<string>"
],
"filters": [
"<string>"
],
"measures": [
"<string>"
],
"rows": [
"<string>"
],
"showAppliedFilters": true,
"showColumnTotals": true,
"showRowTotals": true
},
"publicId": "<string>",
"resultChecksum": {
"chunks": [
{
"from": 1,
"hash": "<string>",
"to": 1
}
],
"v": 2,
"payload": "<string>"
},
"resultLocation": "<string>",
"sheetId": "<string>",
"sqlQuery": "<string>",
"title": "<string>",
"workbookId": 123,
"workbookName": "<string>"
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}"
payload = {
"endResultCell": "<string>",
"externalWorkbookId": "<string>",
"folderId": 123,
"jsonQuery": "<string>",
"meta": {},
"name": "<string>",
"pivotItems": {
"columns": ["<string>"],
"filters": ["<string>"],
"measures": ["<string>"],
"rows": ["<string>"],
"showAppliedFilters": True,
"showColumnTotals": True,
"showRowTotals": True
},
"publicId": "<string>",
"resultChecksum": {
"chunks": [
{
"from": 1,
"hash": "<string>",
"to": 1
}
],
"v": 2,
"payload": "<string>"
},
"resultLocation": "<string>",
"sheetId": "<string>",
"sqlQuery": "<string>",
"title": "<string>",
"workbookId": 123,
"workbookName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endResultCell: '<string>',
externalWorkbookId: '<string>',
folderId: 123,
jsonQuery: '<string>',
meta: {},
name: '<string>',
pivotItems: {
columns: ['<string>'],
filters: ['<string>'],
measures: ['<string>'],
rows: ['<string>'],
showAppliedFilters: true,
showColumnTotals: true,
showRowTotals: true
},
publicId: '<string>',
resultChecksum: {chunks: [{from: 1, hash: '<string>', to: 1}], v: 2, payload: '<string>'},
resultLocation: '<string>',
sheetId: '<string>',
sqlQuery: '<string>',
title: '<string>',
workbookId: 123,
workbookName: '<string>'
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}', 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/deployments/{deploymentId}/reports/by-public-id/{publicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'endResultCell' => '<string>',
'externalWorkbookId' => '<string>',
'folderId' => 123,
'jsonQuery' => '<string>',
'meta' => [
],
'name' => '<string>',
'pivotItems' => [
'columns' => [
'<string>'
],
'filters' => [
'<string>'
],
'measures' => [
'<string>'
],
'rows' => [
'<string>'
],
'showAppliedFilters' => true,
'showColumnTotals' => true,
'showRowTotals' => true
],
'publicId' => '<string>',
'resultChecksum' => [
'chunks' => [
[
'from' => 1,
'hash' => '<string>',
'to' => 1
]
],
'v' => 2,
'payload' => '<string>'
],
'resultLocation' => '<string>',
'sheetId' => '<string>',
'sqlQuery' => '<string>',
'title' => '<string>',
'workbookId' => 123,
'workbookName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}"
payload := strings.NewReader("{\n \"endResultCell\": \"<string>\",\n \"externalWorkbookId\": \"<string>\",\n \"folderId\": 123,\n \"jsonQuery\": \"<string>\",\n \"meta\": {},\n \"name\": \"<string>\",\n \"pivotItems\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n \"<string>\"\n ],\n \"measures\": [\n \"<string>\"\n ],\n \"rows\": [\n \"<string>\"\n ],\n \"showAppliedFilters\": true,\n \"showColumnTotals\": true,\n \"showRowTotals\": true\n },\n \"publicId\": \"<string>\",\n \"resultChecksum\": {\n \"chunks\": [\n {\n \"from\": 1,\n \"hash\": \"<string>\",\n \"to\": 1\n }\n ],\n \"v\": 2,\n \"payload\": \"<string>\"\n },\n \"resultLocation\": \"<string>\",\n \"sheetId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"title\": \"<string>\",\n \"workbookId\": 123,\n \"workbookName\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"endResultCell\": \"<string>\",\n \"externalWorkbookId\": \"<string>\",\n \"folderId\": 123,\n \"jsonQuery\": \"<string>\",\n \"meta\": {},\n \"name\": \"<string>\",\n \"pivotItems\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n \"<string>\"\n ],\n \"measures\": [\n \"<string>\"\n ],\n \"rows\": [\n \"<string>\"\n ],\n \"showAppliedFilters\": true,\n \"showColumnTotals\": true,\n \"showRowTotals\": true\n },\n \"publicId\": \"<string>\",\n \"resultChecksum\": {\n \"chunks\": [\n {\n \"from\": 1,\n \"hash\": \"<string>\",\n \"to\": 1\n }\n ],\n \"v\": 2,\n \"payload\": \"<string>\"\n },\n \"resultLocation\": \"<string>\",\n \"sheetId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"title\": \"<string>\",\n \"workbookId\": 123,\n \"workbookName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endResultCell\": \"<string>\",\n \"externalWorkbookId\": \"<string>\",\n \"folderId\": 123,\n \"jsonQuery\": \"<string>\",\n \"meta\": {},\n \"name\": \"<string>\",\n \"pivotItems\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n \"<string>\"\n ],\n \"measures\": [\n \"<string>\"\n ],\n \"rows\": [\n \"<string>\"\n ],\n \"showAppliedFilters\": true,\n \"showColumnTotals\": true,\n \"showRowTotals\": true\n },\n \"publicId\": \"<string>\",\n \"resultChecksum\": {\n \"chunks\": [\n {\n \"from\": 1,\n \"hash\": \"<string>\",\n \"to\": 1\n }\n ],\n \"v\": 2,\n \"payload\": \"<string>\"\n },\n \"resultLocation\": \"<string>\",\n \"sheetId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"title\": \"<string>\",\n \"workbookId\": 123,\n \"workbookName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-12-25",
"deploymentId": 123,
"id": 123,
"name": "<string>",
"publicId": "<string>",
"refreshedByUser": {
"email": "<string>",
"id": 123,
"firstName": "<string>",
"picture": "<string>"
},
"type": "FOLDER",
"updatedAt": "2023-12-25",
"user": {
"email": "<string>",
"id": 123,
"firstName": "<string>",
"picture": "<string>"
},
"userId": 123,
"canEdit": true,
"canManage": true,
"createdBy": 123,
"currentQueryChecksum": "<string>",
"description": "<string>",
"endResultCell": "<string>",
"externalWorkbookId": "<string>",
"externalWorkbookPlacements": [
{
"resultLocation": "<string>",
"workbookId": "<string>",
"anchorCell": "<string>",
"endResultCell": "<string>",
"host": "GOOGLE_SHEETS",
"id": "<string>",
"placedAt": "<string>",
"placedByUserId": 123,
"queryChecksum": "<string>",
"refreshedAt": "<string>",
"refreshedByUserId": 123,
"resultChecksum": {
"chunks": [
{
"from": 1,
"hash": "<string>",
"to": 1
}
],
"v": 2,
"payload": "<string>"
},
"sheetId": "<string>",
"sheetName": "<string>",
"syncStatus": "UP_TO_DATE",
"workbookName": "<string>"
}
],
"folderId": 123,
"folderPath": [
{
"id": 123,
"name": "<string>"
}
],
"jsonQuery": "<string>",
"meta": {},
"pivotItems": {
"columns": [
"<string>"
],
"filters": [
"<string>"
],
"measures": [
"<string>"
],
"rows": [
"<string>"
],
"displayScale": "model",
"measuresAxis": "columns",
"measuresPosition": "before",
"showAppliedFilters": true,
"showColumnTotals": true,
"showRowTotals": true
},
"refreshedBy": 123,
"resultLocation": "<string>",
"rolesWithAccess": [
{
"actions": [
"All"
],
"id": 123,
"name": "<string>"
}
],
"source": "GOOGLE_SHEETS",
"sqlQuery": "<string>",
"title": "<string>",
"version": 123,
"workbookId": 123
}Reports
Create or update a report by publicId
PUT
/
api
/
v1
/
deployments
/
{deploymentId}
/
reports
/
by-public-id
/
{publicId}
Create or update a report by publicId
curl --request PUT \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endResultCell": "<string>",
"externalWorkbookId": "<string>",
"folderId": 123,
"jsonQuery": "<string>",
"meta": {},
"name": "<string>",
"pivotItems": {
"columns": [
"<string>"
],
"filters": [
"<string>"
],
"measures": [
"<string>"
],
"rows": [
"<string>"
],
"showAppliedFilters": true,
"showColumnTotals": true,
"showRowTotals": true
},
"publicId": "<string>",
"resultChecksum": {
"chunks": [
{
"from": 1,
"hash": "<string>",
"to": 1
}
],
"v": 2,
"payload": "<string>"
},
"resultLocation": "<string>",
"sheetId": "<string>",
"sqlQuery": "<string>",
"title": "<string>",
"workbookId": 123,
"workbookName": "<string>"
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}"
payload = {
"endResultCell": "<string>",
"externalWorkbookId": "<string>",
"folderId": 123,
"jsonQuery": "<string>",
"meta": {},
"name": "<string>",
"pivotItems": {
"columns": ["<string>"],
"filters": ["<string>"],
"measures": ["<string>"],
"rows": ["<string>"],
"showAppliedFilters": True,
"showColumnTotals": True,
"showRowTotals": True
},
"publicId": "<string>",
"resultChecksum": {
"chunks": [
{
"from": 1,
"hash": "<string>",
"to": 1
}
],
"v": 2,
"payload": "<string>"
},
"resultLocation": "<string>",
"sheetId": "<string>",
"sqlQuery": "<string>",
"title": "<string>",
"workbookId": 123,
"workbookName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endResultCell: '<string>',
externalWorkbookId: '<string>',
folderId: 123,
jsonQuery: '<string>',
meta: {},
name: '<string>',
pivotItems: {
columns: ['<string>'],
filters: ['<string>'],
measures: ['<string>'],
rows: ['<string>'],
showAppliedFilters: true,
showColumnTotals: true,
showRowTotals: true
},
publicId: '<string>',
resultChecksum: {chunks: [{from: 1, hash: '<string>', to: 1}], v: 2, payload: '<string>'},
resultLocation: '<string>',
sheetId: '<string>',
sqlQuery: '<string>',
title: '<string>',
workbookId: 123,
workbookName: '<string>'
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}', 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/deployments/{deploymentId}/reports/by-public-id/{publicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'endResultCell' => '<string>',
'externalWorkbookId' => '<string>',
'folderId' => 123,
'jsonQuery' => '<string>',
'meta' => [
],
'name' => '<string>',
'pivotItems' => [
'columns' => [
'<string>'
],
'filters' => [
'<string>'
],
'measures' => [
'<string>'
],
'rows' => [
'<string>'
],
'showAppliedFilters' => true,
'showColumnTotals' => true,
'showRowTotals' => true
],
'publicId' => '<string>',
'resultChecksum' => [
'chunks' => [
[
'from' => 1,
'hash' => '<string>',
'to' => 1
]
],
'v' => 2,
'payload' => '<string>'
],
'resultLocation' => '<string>',
'sheetId' => '<string>',
'sqlQuery' => '<string>',
'title' => '<string>',
'workbookId' => 123,
'workbookName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}"
payload := strings.NewReader("{\n \"endResultCell\": \"<string>\",\n \"externalWorkbookId\": \"<string>\",\n \"folderId\": 123,\n \"jsonQuery\": \"<string>\",\n \"meta\": {},\n \"name\": \"<string>\",\n \"pivotItems\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n \"<string>\"\n ],\n \"measures\": [\n \"<string>\"\n ],\n \"rows\": [\n \"<string>\"\n ],\n \"showAppliedFilters\": true,\n \"showColumnTotals\": true,\n \"showRowTotals\": true\n },\n \"publicId\": \"<string>\",\n \"resultChecksum\": {\n \"chunks\": [\n {\n \"from\": 1,\n \"hash\": \"<string>\",\n \"to\": 1\n }\n ],\n \"v\": 2,\n \"payload\": \"<string>\"\n },\n \"resultLocation\": \"<string>\",\n \"sheetId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"title\": \"<string>\",\n \"workbookId\": 123,\n \"workbookName\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"endResultCell\": \"<string>\",\n \"externalWorkbookId\": \"<string>\",\n \"folderId\": 123,\n \"jsonQuery\": \"<string>\",\n \"meta\": {},\n \"name\": \"<string>\",\n \"pivotItems\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n \"<string>\"\n ],\n \"measures\": [\n \"<string>\"\n ],\n \"rows\": [\n \"<string>\"\n ],\n \"showAppliedFilters\": true,\n \"showColumnTotals\": true,\n \"showRowTotals\": true\n },\n \"publicId\": \"<string>\",\n \"resultChecksum\": {\n \"chunks\": [\n {\n \"from\": 1,\n \"hash\": \"<string>\",\n \"to\": 1\n }\n ],\n \"v\": 2,\n \"payload\": \"<string>\"\n },\n \"resultLocation\": \"<string>\",\n \"sheetId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"title\": \"<string>\",\n \"workbookId\": 123,\n \"workbookName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endResultCell\": \"<string>\",\n \"externalWorkbookId\": \"<string>\",\n \"folderId\": 123,\n \"jsonQuery\": \"<string>\",\n \"meta\": {},\n \"name\": \"<string>\",\n \"pivotItems\": {\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n \"<string>\"\n ],\n \"measures\": [\n \"<string>\"\n ],\n \"rows\": [\n \"<string>\"\n ],\n \"showAppliedFilters\": true,\n \"showColumnTotals\": true,\n \"showRowTotals\": true\n },\n \"publicId\": \"<string>\",\n \"resultChecksum\": {\n \"chunks\": [\n {\n \"from\": 1,\n \"hash\": \"<string>\",\n \"to\": 1\n }\n ],\n \"v\": 2,\n \"payload\": \"<string>\"\n },\n \"resultLocation\": \"<string>\",\n \"sheetId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"title\": \"<string>\",\n \"workbookId\": 123,\n \"workbookName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-12-25",
"deploymentId": 123,
"id": 123,
"name": "<string>",
"publicId": "<string>",
"refreshedByUser": {
"email": "<string>",
"id": 123,
"firstName": "<string>",
"picture": "<string>"
},
"type": "FOLDER",
"updatedAt": "2023-12-25",
"user": {
"email": "<string>",
"id": 123,
"firstName": "<string>",
"picture": "<string>"
},
"userId": 123,
"canEdit": true,
"canManage": true,
"createdBy": 123,
"currentQueryChecksum": "<string>",
"description": "<string>",
"endResultCell": "<string>",
"externalWorkbookId": "<string>",
"externalWorkbookPlacements": [
{
"resultLocation": "<string>",
"workbookId": "<string>",
"anchorCell": "<string>",
"endResultCell": "<string>",
"host": "GOOGLE_SHEETS",
"id": "<string>",
"placedAt": "<string>",
"placedByUserId": 123,
"queryChecksum": "<string>",
"refreshedAt": "<string>",
"refreshedByUserId": 123,
"resultChecksum": {
"chunks": [
{
"from": 1,
"hash": "<string>",
"to": 1
}
],
"v": 2,
"payload": "<string>"
},
"sheetId": "<string>",
"sheetName": "<string>",
"syncStatus": "UP_TO_DATE",
"workbookName": "<string>"
}
],
"folderId": 123,
"folderPath": [
{
"id": 123,
"name": "<string>"
}
],
"jsonQuery": "<string>",
"meta": {},
"pivotItems": {
"columns": [
"<string>"
],
"filters": [
"<string>"
],
"measures": [
"<string>"
],
"rows": [
"<string>"
],
"displayScale": "model",
"measuresAxis": "columns",
"measuresPosition": "before",
"showAppliedFilters": true,
"showColumnTotals": true,
"showRowTotals": true
},
"refreshedBy": 123,
"resultLocation": "<string>",
"rolesWithAccess": [
{
"actions": [
"All"
],
"id": 123,
"name": "<string>"
}
],
"source": "GOOGLE_SHEETS",
"sqlQuery": "<string>",
"title": "<string>",
"version": 123,
"workbookId": 123
}Idempotent create-or-update (“upsert”) of a report keyed by its portable
publicId — the stable identity for managing dashboards as code (CI/CD pipelines re-applying the same definition against any environment).
If a report with this publicId exists in the deployment, it is updated with the fields you send (same semantics as PUT /reports/:reportId); otherwise a new report is created with this publicId. Re-applying the same request is a no-op. The publicId must be a 12-character alphanumeric id ([0-9A-Za-z]); mint one client-side when authoring the definition.
This endpoint returns 409 for three different reasons, distinguished by the response body’s code — handle them differently:
- No
code— thepublicIdalready belongs to a report in a different deployment. BecausepublicIdis unique across the account, it is rejected rather than silently updating across deployments (reported regardless of whether you have access to that report). This is permanent: retrying will not help; use a differentpublicId. code: "upsert_branch_changed"— whether this request creates or updates is decided, and access-checked, before it is applied; another writer changed that in between (created or deleted the report with thispublicId). The request was rejected rather than applied under the wrong permission check. This is transient: retry the request. It only happens when two writers target the samepublicIdconcurrently, e.g. two pipeline runs applying the same bundle at once.code: "ambiguous_legacy_id"— the id given is one of the ids synthesized for reports that predate stable ids (see below), and it matches more than one of them, so it cannot identify a single report. Nothing was changed. This is permanent, and the fix is different from the case above: assign the report you mean apublicIdof your own withPUT /deployments/{deploymentId}/reports/{reportId}, then key on that.
publicId; the API synthesizes one for them from the report’s internal id. Those synthesized ids are not unique — several reports can share one, and in practice most do. This endpoint resolves such an id only when it is unambiguous, adopting it as the report’s real publicId at that point; otherwise it returns the ambiguous_legacy_id conflict above.
For anything you intend to manage as code, do not rely on a synthesized id: give the report a publicId you chose. PUT /deployments/{deploymentId}/reports/{reportId} accepts publicId for exactly this, on any report that does not have one yet (it is write-once — a report’s existing publicId cannot be changed, since clients may already have stored it).
source is create-only: it is recorded when the report is first created and ignored on subsequent updates (it describes where the report originated, not its current definition).
Access: updating requires edit access to the existing report; moving it to a different parent requires manage access to the report and edit access to the destination. Creating requires the same access as POST /reports.Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Body
application/json
CreateReportInput
Available options:
GOOGLE_SHEETS, EXCEL Maximum string length:
255Show child attributes
Show child attributes
Required string length:
12Pattern:
^[0-9A-Za-z]+$Show child attributes
Show child attributes
Available options:
GOOGLE_SHEETS, EXCEL, PLAYGROUND, D3 Maximum string length:
255Response
200 - application/json
Maximum string length:
255Required string length:
12Pattern:
^[0-9A-Za-z]+$Show child attributes
Show child attributes
Available options:
FOLDER, WORKBOOK, REPORT Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
GOOGLE_SHEETS, EXCEL, PLAYGROUND, D3