Skip to main content
Run workbook session

Authorizations

Authorization
string
header
required

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

Path Parameters

workspace_slug
string
required

URL-friendly workspace identifier

Example:

"acme"

Query Parameters

filter_id
string<uuid>
Example:

"550e8400-e29b-41d4-a716-446655440000"

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
rows
integer
default:20

Number of rows per page. Use -1 to return all records without pagination.

Required range: x >= -1

Body

application/json
table
object
required
columns
object[]
required
pivots
object[]
filters
object[]
sorts
object[]

Response

Workbook query result

data
object[]
columns
object[]
pivots
string[]
dashboard_filters
object[]
info
object
errors
object[]
updated_at
string<date-time>
Example:

"2024-01-15T10:30:00Z"

Last modified on July 23, 2026