OBJECT

Dashboard

A dashboard contained in a published workbook.

link GraphQL Schema definition

  • type Dashboard implements View, Taggable {
  • # Unique identifier used by the metadata API. Not the same as the numeric ID used
  • # on server
  • id: ID!
  • # Name shown in server and desktop clients
  • name: String
  • # Unique ID for the dashboard generated for and stored within the workbook,
  • # survives renames, and is used for internal processes
  • documentViewId: String
  • # Locally unique identifier used for the REST API on the Tableau Server (Blank if
  • # worksheet is hidden in Workbook)
  • luid: String!
  • # Server path to dashboard
  • path: String
  • # Time the dashboard was created
  • createdAt: DateTime!
  • # Time the dashboard was updated
  • updatedAt: DateTime!
  • # Index of view; the order it appears in the workbook
  • index: Int
  • # Tags associated with the view
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • tags(filter: Tag_Filter, orderBy: TagSortOrder): [Tag!]!
  • # Tags associated with the view
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • tagsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Tag_Filter,
  • orderBy: TagSortOrder
  • ): TagsConnection
  • # Sheets referenced by this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • sheets(
  • filter: Sheet_Filter,
  • orderBy: SheetSortOrder,
  • permissionMode: PermissionMode
  • ): [Sheet!]!
  • # Sheets referenced by this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • sheetsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Sheet_Filter,
  • orderBy: SheetSortOrder,
  • permissionMode: PermissionMode
  • ): SheetsConnection
  • # AskDataExtensions that are added into this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • askDataExtensions(
  • filter: AskDataExtension_Filter,
  • orderBy: AskDataExtensionSortOrder,
  • permissionMode: PermissionMode
  • ): [AskDataExtension!]!
  • # AskDataExtensions that are added into this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • askDataExtensionsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: AskDataExtension_Filter,
  • orderBy: AskDataExtensionSortOrder,
  • permissionMode: PermissionMode
  • ): AskDataExtensionsConnection
  • # Sheet field instances used by the sheets referenced by this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamSheetFieldInstances(
  • filter: Field_Filter,
  • orderBy: FieldSortOrder,
  • permissionMode: PermissionMode
  • ): [Field]
  • # Sheet field instances used by the sheets referenced by this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamSheetFieldInstancesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Field_Filter,
  • orderBy: FieldSortOrder,
  • permissionMode: PermissionMode
  • ): FieldsConnection
  • # Data quality warnings upstream from this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDataQualityWarnings(
  • filter: DataQualityWarning_Filter,
  • orderBy: DataQualityWarningSortOrder,
  • permissionMode: PermissionMode
  • ): [DataQualityWarning!]!
  • # Data quality warnings upstream from this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDataQualityWarningsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DataQualityWarning_Filter,
  • orderBy: DataQualityWarningSortOrder,
  • permissionMode: PermissionMode
  • ): DataQualityWarningsConnection
  • # Labels upstream from this dashboard Available in Tableau Cloud March 2023 /
  • # Server 2023.1 and later.
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamLabels(
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): [Label!]!
  • # Labels upstream from this dashboard Available in Tableau Cloud March 2023 /
  • # Server 2023.1 and later.
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamLabelsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): LabelsConnection
  • # The workbook that contains this view
  • workbook: Workbook
  • # The Metrics that reference this View
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • referencedByMetrics(
  • filter: Metric_Filter,
  • orderBy: MetricSortOrder,
  • permissionMode: PermissionMode
  • ): [Metric]
  • # The Metrics that reference this View
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • referencedByMetricsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Metric_Filter,
  • orderBy: MetricSortOrder,
  • permissionMode: PermissionMode
  • ): MetricsConnection
  • # The databases that are upstream of this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatabases(
  • filter: Database_Filter,
  • orderBy: DatabaseSortOrder,
  • permissionMode: PermissionMode
  • ): [Database]
  • # The databases that are upstream of this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatabasesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Database_Filter,
  • orderBy: DatabaseSortOrder,
  • permissionMode: PermissionMode
  • ): DatabasesConnection
  • # The data sources that are upstream of this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatasources(
  • filter: Datasource_Filter,
  • orderBy: DatasourceSortOrder,
  • permissionMode: PermissionMode
  • ): [Datasource]
  • # The data sources that are upstream of this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatasourcesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Datasource_Filter,
  • orderBy: DatasourceSortOrder,
  • permissionMode: PermissionMode
  • ): DatasourcesConnection
  • # The tables that are upstream of this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamTables(
  • filter: Table_Filter,
  • orderBy: TableSortOrder,
  • permissionMode: PermissionMode
  • ): [Table]
  • # The tables that are upstream of this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamTablesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Table_Filter,
  • orderBy: TableSortOrder,
  • permissionMode: PermissionMode
  • ): TablesConnection
  • # The fields that are upstream of this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamFields(
  • filter: Field_Filter,
  • orderBy: FieldSortOrder,
  • permissionMode: PermissionMode
  • ): [Field]
  • # The fields that are upstream of this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamFieldsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Field_Filter,
  • orderBy: FieldSortOrder,
  • permissionMode: PermissionMode
  • ): FieldsConnection
  • # The flows that are upstream of this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamFlows(
  • filter: Flow_Filter,
  • orderBy: FlowSortOrder,
  • permissionMode: PermissionMode
  • ): [Flow]
  • # The flows that are upstream of this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamFlowsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Flow_Filter,
  • orderBy: FlowSortOrder,
  • permissionMode: PermissionMode
  • ): FlowsConnection
  • # The Lenses that are upstream of this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamLenses(
  • filter: Lens_Filter,
  • orderBy: LensSortOrder,
  • permissionMode: PermissionMode
  • ): [Lens]
  • # The Lenses that are upstream of this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamLensesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Lens_Filter,
  • orderBy: LensSortOrder,
  • permissionMode: PermissionMode
  • ): LensesConnection
  • # The columns that are upstream of this dashboard
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamColumns(
  • filter: Column_Filter,
  • orderBy: ColumnSortOrder,
  • permissionMode: PermissionMode
  • ): [Column]
  • # The columns that are upstream of this dashboard
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamColumnsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Column_Filter,
  • orderBy: ColumnSortOrder,
  • permissionMode: PermissionMode
  • ): ColumnsConnection
  • }

link Require by