Skip to main content
export_worksheet

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
worksheetId
string
required

Worksheet to export, under the calling user’s access permissions.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
columnIds
string[]
required

Columns to export, in CSV column order.

Required array length: 1 - 200 elements
Minimum string length: 1
headers
object

CSV header per column id; columns left out use their id.

where
object[]

AND filters. Saved worksheet view filters are not applied automatically.

Maximum array length: 20
orderBy
object[]

Sort keys in priority order; a ranking by an aggregate must already exist as a column.

Maximum array length: 20

Response

200

Tool result.