The sharedDashboards() GraphQL query gets a shared dashboard by it's shared link token.

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.

Syntax

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

graphql
sharedDashboards(
      token: string!
   ): SharedDashboard!

Returned Datatypes

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

Table: SharedDashboard

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier of the shared dashboard.
namestringyes The name of the shared dashboard.
displayNamestringyes The display name of the shared dashboard.
ipFilterIPFilteryes The shared dashboard's IP filter (see IPFilter Table).
sharedTimeIntervalstringyes The time interval of the shared dashboard.
repoOrViewNamestringyes The name of the repository or view on which queries are executed.
widgets[Widget]yes The widgets used in the shared dashboard (see Widget 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.