Sign in

v1

latestOpenAPI 3.1.02026-07-263971,2281.1 MB
DashboardService

ListDashboards

post/textql.rpc.public.dashboard.DashboardService/ListDashboards

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

searchTermstring nullable
myDashboardsOnlyboolean nullable
sortBy'DASHBOARD_SORT_FIELD_UNSPECIFIED' | 'DASHBOARD_SORT_FIELD_NAME' | 'DASHBOARD_SORT_FIELD_CREATED_AT' | 'DASHBOARD_SORT_FIELD_UPDATED_AT' | 'DASHBOARD_SORT_FIELD_REFRESHED_AT'
sortDirection'SORT_DIRECTION_UNKNOWN' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

Common enum for sort direction used across multiple services

limitinteger
offsetinteger
folderIdstring nullable

Filter by specific folder

uncategorizedOnlyboolean nullable

Only show dashboards with no folder

creatorMemberIdstring nullable

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

sharedWithMeboolean nullable
creatorMemberIdsstring[]

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

statusFilter'DASHBOARD_STATUS_UNSPECIFIED' | 'DASHBOARD_STATUS_DRAFT' | 'DASHBOARD_STATUS_PUBLISHED'

Response

Success

totalCountinteger

Example response

{
  "dashboards": [
    {
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "refreshedAt": "2023-01-15T01:30:15.01Z",
      "publishedAt": "2023-01-15T01:30:15.01Z",
      "latestScheduledRunAt": "2023-01-15T01:30:15.01Z"
    }
  ]
}