Start a full database view export from a structured request.
Start a full database view export from a structured request. The request is scoped to the authenticated instance and enforces View access and lifecycle state.
Authorizations
Bearer JWT token or API Key (sk-*).
Path Parameters
Provide databaseViewId.
Body
Include the total count in the response envelope. Accepts boolean query values such as true or false.
true
Structured QueryWrapper filter tree.
"{\"and\":[{\"field\":\"name\",\"op\":\"ilike\",\"value\":\"Ops\"},{\"field\":\"deletedAt\",\"op\":\"isNull\"}]}"
Structured sort definition or ordered sort fields.
"{\"name\":\"ASC\",\"lastUpdateAt\":\"DESC\"}"
Structured distinct field selection.
"category,global"
Selected plain or computed QueryWrapper fields.
"[\"databaseId\",\"name\",{\"fn\":\"COUNT\",\"args\":[\"users.userId\"],\"as\":\"userCount\",\"filterType\":\"number\"}]"
Structured dynamic database joins.
"[{\"table\":\"groups_users\",\"alias\":\"gu\",\"type\":\"left\",\"on\":{\"left\":\"gu.groupsGroupId\",\"op\":\"=\",\"right\":\"g.groupId\"}}]"
Structured group-by field selection.
"[\"category\",\"global\"]"
Structured selected-field cast mapping.
"{\"userCount\":\"INTEGER\"}"
Structured CTE definitions when the export source permits them.
"[{\"name\":\"active_groups\",\"query\":{\"from\":{\"table\":\"groups\",\"alias\":\"g\",\"definition\":[]}}}]"
Enable QueryWrapper debug output for the request, including compiled SQL, bound params, and bounded EXPLAIN plans when the underlying query service supports it.
false
Legacy dynamic database join map.
"{\"orders\":[\"customerId\",\"customerId\",\"left\"]}"
Output format. CSV remains the default; XLSX uses the native streaming Storage writer.
csv, xlsx "xlsx"
Export file retention. Omit for the destination default, set null for no expiration, or provide exactly one of ttlSeconds and expiresAt.
CSV field delimiter. Defaults to a comma and must contain fewer than 10 characters.
"|"
CSV boolean representation.
emoji, number, boolean "boolean"
Write null values as empty CSV fields instead of the string null.
true
Base64-encode JSON and JSONB values in the CSV output.
false
Optional storage destination. Omit to retain the private per-user export namespace, use ROOT for the explorer root, or provide an accessible explorer folder storageEntryId.
"ROOT"
Dedicated export file name. Path separators are not allowed. Omit to generate a database-and-timestamp name with the selected format extension.
"contracts-full.xlsx"
Whether the exported storage entry is restricted. Defaults to true. Restricted ancestors still apply when exporting into a folder.
false
Response
Export accepted.

