Queries

Bulk create or update queries

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

put/v1/queries/bulk

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/queries/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
displayNamestring
descriptionstring
querystring required
query_typestring
exclude_usageboolean
durationnumber double
usersstring[]
usedBystring[]
dialectstring
queryDateinteger
processedLineageboolean
servicestring required
domainsstring[]
extensionobject
dataProductsstring[]

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.