Skip to content

Variable: listDashboardsRequestSchema

const listDashboardsRequestSchema: ZodObject<{ page_size: ZodOptional<ZodNumber>; page_token: ZodOptional<ZodString>; show_trashed: ZodOptional<ZodBoolean>; view: ZodOptional<ZodLiteral<"DASHBOARD_VIEW_BASIC">>; }, $strip>

  • page_size (optional): The number of dashboards to return per page.
  • page_token (optional): A page token, received from a previous ListDashboards call. This token can be used to retrieve the subsequent page.
  • show_trashed (optional): The flag to include dashboards located in the trash. If unspecified, only active dashboards will be returned.
  • view (optional): DASHBOARD_VIEW_BASIConly includes summary metadata from the dashboard.