Skip to main content
DELETE
Disconnect a report from one spot in a spreadsheet
Remove a single placement of a report — one sheet + anchor in one spreadsheet — leaving every other placement, in this workbook and in others, alone. Address the placement by placementId, or (for placements recorded before ids existed) by externalWorkbookId plus sheetName and anchorCell — or a resultLocation naming both. Neither the sheet name nor the anchor is optional in that form: matching is by sheet + anchor, and a target missing either addresses nothing. sheetId is an optional extra, not a substitute for sheetName: a placement written before that field existed has only a name, and no id the server could resolve to it, so an id-only address would match nothing while looking correct. Send a sheetId only when you know it is the one the placement was stored with. It NARROWS the target — a placement recorded under a different id is not matched, even when the sheet name and anchor agree, because the stored name may belong to a tab that has since been renamed and the id is the only stable identity. If your id may have moved on (a tab deleted and recreated under the same name reports a new one), address the placement by placementId, or by sheet name with no sheetId at all. A target that matches no placement succeeds and changes nothing, so retrying is safe. Like connecting, this records nothing about the report’s definition and so requires only read access: unplacing a report from your own sheet is not an edit to the report.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
reportId
number
required

Body

application/json

DisconnectReportFromWorkbookInput

anchorCell
string | null
externalWorkbookId
string | null
placementId
string | null
resultLocation
string | null
sheetId
string | null
sheetName
string | null

Response

200 - application/json
createdAt
required
deploymentId
integer
required
id
integer
required
name
string
required
publicId
string
required
Required string length: 12
Pattern: ^[0-9A-Za-z]+$
refreshedByUser
object
required
type
enum<string>
required
Available options:
FOLDER,
WORKBOOK,
REPORT
updatedAt
required
user
object
required
userId
integer
required
canEdit
boolean | null
canManage
boolean | null
createdBy
integer
description
string | null
endResultCell
string | null
externalWorkbookId
string | null
externalWorkbookPlacements
object[] | null
folderId
integer | null
folderPath
object[]
jsonQuery
string | null
meta
object | null
pivotItems
object | null
refreshedBy
integer | null
resultLocation
string | null
rolesWithAccess
object[] | null
source
enum<string> | null
Available options:
GOOGLE_SHEETS,
EXCEL,
PLAYGROUND,
D3
sqlQuery
string | null
title
string | null
version
integer | null
workbookId
integer | null