INTERFACE

AnalyticsField

Base GraphQL type for a field containing analytics metadata

link GraphQL Schema definition

  • interface AnalyticsField {
  • # Default format for number or date
  • defaultFormat: String
  • # For geographic data, the geographic role of the field. See
  • # https://onlinehelp.tableau.com/current/pro/desktop/en-us/maps_geographicroles.html
  • semanticRole: String
  • # Default aggregation of the field, i.e. 'Sum', 'Average'. See
  • # https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_aggregation.html#AggFuncs
  • aggregation: String
  • # For the percentile aggregation, the percentile number
  • aggregationParam: String
  • # The bin field that references this field
  • #
  • # 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.
  • referencedByBins(
  • filter: BinField_Filter,
  • orderBy: BinFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [BinField]
  • # The bin field that references this field
  • #
  • # 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.
  • referencedByBinsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: BinField_Filter,
  • orderBy: BinFieldSortOrder,
  • permissionMode: PermissionMode
  • ): BinFieldsConnection
  • # Sheets that reference this field
  • #
  • # 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.
  • directSheets(
  • filter: Sheet_Filter,
  • orderBy: SheetSortOrder,
  • permissionMode: PermissionMode
  • ): [Sheet]
  • # Sheets that reference this field
  • #
  • # 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.
  • directSheetsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Sheet_Filter,
  • orderBy: SheetSortOrder,
  • permissionMode: PermissionMode
  • ): SheetsConnection
  • # The set field that this field references
  • #
  • # 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.
  • referencedBySets(
  • filter: SetField_Filter,
  • orderBy: SetFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [SetField]
  • # The set field that this field references
  • #
  • # 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.
  • referencedBySetsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: SetField_Filter,
  • orderBy: SetFieldSortOrder,
  • permissionMode: PermissionMode
  • ): SetFieldsConnection
  • # The field that references this remote field
  • #
  • # 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.
  • referencedByRemoteFields(
  • filter: DatasourceField_Filter,
  • orderBy: DatasourceFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [DatasourceField]
  • # The field that references this remote field
  • #
  • # 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.
  • referencedByRemoteFieldsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DatasourceField_Filter,
  • orderBy: DatasourceFieldSortOrder,
  • permissionMode: PermissionMode
  • ): DatasourceFieldsConnection
  • # The hierarchy field that references this field
  • #
  • # 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.
  • referencedByHierarchies(
  • filter: HierarchyField_Filter,
  • orderBy: HierarchyFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [HierarchyField]
  • # The hierarchy field that references this field
  • #
  • # 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.
  • referencedByHierarchiesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: HierarchyField_Filter,
  • orderBy: HierarchyFieldSortOrder,
  • permissionMode: PermissionMode
  • ): HierarchyFieldsConnection
  • # The field that references this field
  • #
  • # 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.
  • referencedByFields(
  • filter: FieldReferencingField_Filter,
  • orderBy: FieldReferencingFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [FieldReferencingField]
  • # The field that references this field
  • #
  • # 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.
  • referencedByFieldsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: FieldReferencingField_Filter,
  • orderBy: FieldReferencingFieldSortOrder,
  • permissionMode: PermissionMode
  • ): FieldReferencingFieldsConnection
  • # The data source filters that include this field
  • #
  • # 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.
  • referencedByFilters(
  • filter: DatasourceFilter_Filter,
  • orderBy: DatasourceFilterSortOrder,
  • permissionMode: PermissionMode
  • ): [DatasourceFilter]
  • # The data source filters that include this field
  • #
  • # 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.
  • referencedByFiltersConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DatasourceFilter_Filter,
  • orderBy: DatasourceFilterSortOrder,
  • permissionMode: PermissionMode
  • ): DatasourceFiltersConnection
  • # Thie combined set field that references this field
  • #
  • # 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.
  • referencedByCombinedSets(
  • filter: CombinedSetField_Filter,
  • orderBy: CombinedSetFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [CombinedSetField]
  • # Thie combined set field that references this field
  • #
  • # 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.
  • referencedByCombinedSetsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: CombinedSetField_Filter,
  • orderBy: CombinedSetFieldSortOrder,
  • permissionMode: PermissionMode
  • ): CombinedSetFieldsConnection
  • # A flow output field that wraps this field
  • #
  • # 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.
  • referencedByFlowFieldOutputField(
  • filter: FlowFieldOutputField_Filter,
  • orderBy: FlowFieldOutputFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [FlowFieldOutputField]
  • # A flow output field that wraps this field
  • #
  • # 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.
  • referencedByFlowFieldOutputFieldConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: FlowFieldOutputField_Filter,
  • orderBy: FlowFieldOutputFieldSortOrder,
  • permissionMode: PermissionMode
  • ): FlowFieldOutputFieldsConnection
  • # Sheets that reference this data source field
  • #
  • # 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 that reference this data source field
  • #
  • # 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
  • # A flow input field that wraps this field
  • #
  • # 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.
  • referencedByFlowFieldInputField(
  • filter: FlowFieldInputField_Filter,
  • orderBy: FlowFieldInputFieldSortOrder
  • ): [FlowFieldInputField]
  • # A flow input field that wraps this field
  • #
  • # 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.
  • referencedByFlowFieldInputFieldConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: FlowFieldInputField_Filter,
  • orderBy: FlowFieldInputFieldSortOrder
  • ): FlowFieldInputFieldsConnection
  • # The calculated field that references this field
  • #
  • # 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.
  • referencedByCalculations(
  • filter: CalculatedField_Filter,
  • orderBy: CalculatedFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [CalculatedField]
  • # The calculated field that references this field
  • #
  • # 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.
  • referencedByCalculationsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: CalculatedField_Filter,
  • orderBy: CalculatedFieldSortOrder,
  • permissionMode: PermissionMode
  • ): CalculatedFieldsConnection
  • # Data source that contains this field
  • datasource: Datasource
  • # The group field that references this field
  • #
  • # 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.
  • referencedByGroups(
  • filter: GroupField_Filter,
  • orderBy: GroupFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [GroupField]
  • # The group field that references this field
  • #
  • # 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.
  • referencedByGroupsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: GroupField_Filter,
  • orderBy: GroupFieldSortOrder,
  • permissionMode: PermissionMode
  • ): GroupFieldsConnection
  • # The combined field that references this field
  • #
  • # 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.
  • referencedByCombinedFields(
  • filter: CombinedField_Filter,
  • orderBy: CombinedFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [CombinedField]
  • # The combined field that references this field
  • #
  • # 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.
  • referencedByCombinedFieldsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: CombinedField_Filter,
  • orderBy: CombinedFieldSortOrder,
  • permissionMode: PermissionMode
  • ): CombinedFieldsConnection
  • # List of lens fields which are derived from this field
  • #
  • # 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.
  • derivedLensFields(
  • filter: LensField_Filter,
  • orderBy: LensFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [LensField]
  • # List of lens fields which are derived from this field
  • #
  • # 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.
  • derivedLensFieldsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: LensField_Filter,
  • orderBy: LensFieldSortOrder,
  • permissionMode: PermissionMode
  • ): LensFieldsConnection
  • }