Report Deliveries

Update a report delivery

Changed on
put/api/v1/deployments/{deploymentId}/report-deliveries/{id}

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/report-deliveries/{id}
  • Auth: HTTP bearer

Path parameters

deploymentIdinteger required

Numeric id of the deployment that owns the delivery.

idinteger required

Numeric id of the report delivery.

Request body

namestring nullable
ownerUserIdinteger nullable

Transfer the delivery to this active user, who must be able to read its report. They become owner and run-as user. Admins only.

reportIdinteger nullable

Deliver another report. The caller must be able to read it.

writeMode'overwrite' | 'append' | 'new_sheet'

Response

deploymentIdinteger required
idinteger required
lastRunAtstring date-time nullable

When the last run finished. null before the first.

lastSuccessAtstring date-time nullable

When the last successful run finished. null if none has succeeded.

namestring required
nextRunAtunknown
ownerUserIdinteger nullable

The accountable user, whose Google account writes the sheet. null once that user has been deleted.

pausedAtunknown
reportIdinteger nullable

The delivered report. null once that report has been deleted.

reportNamestring nullable

Name of the delivered report. null once that report has been deleted.

reportPublicIdstring nullable

Public id of the delivered report. null once that report has been deleted.

reportWorkbookIdinteger nullable

Workbook holding the delivered report. null once that report has been deleted.

runAsUserIdinteger nullable

The user whose data access the query runs with. null once that user has been deleted.

runningSincestring date-time nullable

When the run still in progress started. null while no run is going.

sheetTitlestring nullable

Current title of the destination tab, read from Google at most every few minutes. null for a new_sheet delivery, or before its title has been read.

spreadsheetTitlestring nullable

Title of the destination spreadsheet, read from Google at most every few minutes and by each run. null before then.

status'active' | 'failing' | 'needs_reconnect' | 'no_sheet_access' | 'orphaned' required
writeMode'overwrite' | 'append' | 'new_sheet' required

Changes