Dashboards

Bulk create or update dashboards

Create or update multiple dashboards in a single operation. Returns a BulkOperationResult with success/failure details for each dashboard.

put/v1/dashboards/bulk

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dashboards/bulk
  • Auth: HTTP bearer

Query parameters

overrideMetadataboolean

When true, allows the bulk update to overwrite user-curated fields (description, displayName, owners, tags) that bot-driven updates normally preserve, and disables the sourceHash fast-path so unchanged entities are re-evaluated. Defaults to false.

asyncboolean

Request body

namestring required
displayNamestring
descriptionstring
dashboardType'Dashboard' | 'Report'
sourceUrlstring
projectstring
chartsstring[]
dataModelsstring[]
servicestring required
extensionobject
domainsstring[]
dataProductsstring[]
sourceHashstring

Response

Bulk operation results

dryRunboolean
status'success' | 'failure' | 'aborted' | 'partialSuccess' | 'running'
abortReasonstring
numberOfRowsProcessedinteger
numberOfRowsPassedinteger
numberOfRowsFailedinteger

Changes

No recorded changes to this operation across all 1 revision of this API.