The dashboardsPage() GraphQL query is used to retrieve a dashboard. This field is not yet available. It's described here as a preview and is used for getting a new pagination pattern.

For more information on dashboards, see the Dashboards & Widgets documentation page. You may also want to look at the Dashboards page in the Training section.


Below is the syntax for the dashboardsPage() query field:

   search: string
   pageNumber: integer!
   pageSize: integer!
): DashboardPage!

Returned Datatypes

The returned datatype DashboardPage has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: DashboardPage

pageInfoPageTypeyes Information about the dashboards page (see PageType Table).
page[Dashboard]yes The dashboards to be used for the dashboard page (see Dashboard Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.