Skip to main content
POST
Python (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
searchTerm
string | null
myDashboardsOnly
boolean | null
sortBy
enum<string> | null
Available options:
DASHBOARD_SORT_FIELD_UNSPECIFIED,
DASHBOARD_SORT_FIELD_NAME,
DASHBOARD_SORT_FIELD_CREATED_AT,
DASHBOARD_SORT_FIELD_UPDATED_AT,
DASHBOARD_SORT_FIELD_REFRESHED_AT
sortDirection
enum<string> | null

Common enum for sort direction used across multiple services

Available options:
SORT_DIRECTION_UNKNOWN,
SORT_DIRECTION_ASC,
SORT_DIRECTION_DESC
limit
integer<int32>
offset
integer<int32>
folderId
string | null

Filter by specific folder

uncategorizedOnly
boolean | null

Only show dashboards with no folder

creatorMemberId
string | null

Filter by specific creator member ID (single-select; superseded by creator_member_ids when non-empty)

sharedWithMe
boolean | null
creatorMemberIds
string[]

Multi-select creator filter (union). Supersedes creator_member_id when non-empty.

statusFilter
enum<string> | null

Filter by status (Draft / Published). Unset = all statuses.

Available options:
DASHBOARD_STATUS_UNSPECIFIED,
DASHBOARD_STATUS_DRAFT,
DASHBOARD_STATUS_PUBLISHED

Response

Success

dashboards
Dashboard · object[]
totalCount
integer<int32>