[ aws . quicksight ]

create-analysis

Description

Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition .

See also: AWS API Documentation

Synopsis

  create-analysis
--aws-account-id <value>
--analysis-id <value>
--name <value>
[--parameters <value>]
[--permissions <value>]
[--source-entity <value>]
[--theme-arn <value>]
[--tags <value>]
[--definition <value>]
[--validation-strategy <value>]
[--folder-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--aws-account-id (string) [required]

The ID of the Amazon Web Services account where you are creating an analysis.

Constraints:

• min: 12
• max: 12
• pattern: ^[0-9]{12}$

--analysis-id (string) [required]

The ID for the analysis that you’re creating. This ID displays in the URL of the analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

--name (string) [required]

A descriptive name for the analysis that you’re creating. This name displays for the analysis in the Amazon Quick Sight console.

Constraints:

• min: 1
• max: 2048

--parameters (structure)

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

StringParameters -> (list)

The parameters that have a data type of string.

Constraints:

• max: 100

(structure)

A string parameter.

Name -> (string) [required]

A display name for a string parameter.

Constraints:

• pattern: .*\S.*

Values -> (list) [required]

The values of a string parameter.

(string)

IntegerParameters -> (list)

The parameters that have a data type of integer.

Constraints:

• max: 100

(structure)

An integer parameter.

Name -> (string) [required]

The name of the integer parameter.

Constraints:

• pattern: .*\S.*

Values -> (list) [required]

The values for the integer parameter.

(long)

DecimalParameters -> (list)

The parameters that have a data type of decimal.

Constraints:

• max: 100

(structure)

A decimal parameter.

Name -> (string) [required]

A display name for the decimal parameter.

Constraints:

• pattern: .*\S.*

Values -> (list) [required]

The values for the decimal parameter.

(double)

DateTimeParameters -> (list)

The parameters that have a data type of date-time.

Constraints:

• max: 100

(structure)

A date-time parameter.

Name -> (string) [required]

A display name for the date-time parameter.

Constraints:

• pattern: .*\S.*

Values -> (list) [required]

The values for the date-time parameter.

(timestamp)

JSON Syntax:

{
  "StringParameters": [
    {
      "Name": "string",
      "Values": ["string", ...]
    }
    ...
  ],
  "IntegerParameters": [
    {
      "Name": "string",
      "Values": [long, ...]
    }
    ...
  ],
  "DecimalParameters": [
    {
      "Name": "string",
      "Values": [double, ...]
    }
    ...
  ],
  "DateTimeParameters": [
    {
      "Name": "string",
      "Values": [timestamp, ...]
    }
    ...
  ]
}

--permissions (list)

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions .

Constraints:

• min: 1
• max: 64

(structure)

Permission for the resource.

Principal -> (string) [required]

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

• The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
• The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
• The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

Constraints:

• min: 1
• max: 256

Actions -> (list) [required]

The IAM action to grant or revoke permissions on.

Constraints:

• min: 1
• max: 20

(string)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--source-entity (structure)

A source entity to use for the analysis that you’re creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

SourceTemplate -> (structure)

The source template for the source entity of the analysis.

DataSetReferences -> (list) [required]

The dataset references of the source template of an analysis.

Constraints:

• min: 1

(structure)

Dataset reference.

DataSetPlaceholder -> (string) [required]

Dataset placeholder.

Constraints:

• pattern: .*\S.*

DataSetArn -> (string) [required]

Dataset Amazon Resource Name (ARN).

Arn -> (string) [required]

The Amazon Resource Name (ARN) of the source template of an analysis.

JSON Syntax:

{
  "SourceTemplate": {
    "DataSetReferences": [
      {
        "DataSetPlaceholder": "string",
        "DataSetArn": "string"
      }
      ...
    ],
    "Arn": "string"
  }
}

--theme-arn (string)

The ARN for the theme to apply to the analysis that you’re creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.

--tags (list)

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Constraints:

• min: 1
• max: 200

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string) [required]

Tag key.

Constraints:

• min: 1
• max: 128

Value -> (string) [required]

Tag value.

Constraints:

• min: 1
• max: 256

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--definition (structure)

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

DataSetIdentifierDeclarations -> (list) [required]

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

Constraints:

• min: 1
• max: 50

(structure)

A data set.

Identifier -> (string) [required]

The identifier of the data set, typically the data set’s name.

Constraints:

• min: 1
• max: 2048

DataSetArn -> (string) [required]

The Amazon Resource Name (ARN) of the data set.

Sheets -> (list)

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

Constraints:

• max: 20

(structure)

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

SheetId -> (string) [required]

The unique identifier of a sheet.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string)

The title of the sheet.

Constraints:

• min: 1
• max: 1024

Description -> (string)

A description of the sheet.

Constraints:

• min: 1
• max: 1024

Name -> (string)

The name of the sheet. This name is displayed on the sheet’s tab in the Quick Suite console.

Constraints:

• min: 1
• max: 2048

ParameterControls -> (list)

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide .

Constraints:

• max: 200

(structure)

The control of a parameter that users can interact with in a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

DateTimePicker -> (structure)

A control from a date parameter that specifies date and time.

ParameterControlId -> (string) [required]

The ID of the ParameterDateTimePickerControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the ParameterDateTimePickerControl .

Constraints:

• min: 1
• max: 2048

SourceParameterName -> (string) [required]

The name of the ParameterDateTimePickerControl .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

DateTimeFormat -> (string)

Customize how dates are formatted in controls.

Constraints:

• min: 1
• max: 128

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

HelperTextVisibility -> (string)

The helper text visibility of the DateTimePickerControlDisplayOptions .

Possible values:

• HIDDEN
• VISIBLE

DateIconVisibility -> (string)

The date icon visibility of the DateTimePickerControlDisplayOptions .

Possible values:

• HIDDEN
• VISIBLE

List -> (structure)

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

ParameterControlId -> (string) [required]

The ID of the ParameterListControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the ParameterListControl .

Constraints:

• min: 1
• max: 2048

SourceParameterName -> (string) [required]

The source parameter name of the ParameterListControl .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

DisplayOptions -> (structure)

The display options of a control.

SearchOptions -> (structure)

The configuration of the search options in a list control.

Visibility -> (string)

The visibility configuration of the search options in a list control.

Possible values:

• HIDDEN
• VISIBLE

SelectAllOptions -> (structure)

The configuration of the Select all options in a list control.

Visibility -> (string)

The visibility configuration of the Select all options in a list control.

Possible values:

• HIDDEN
• VISIBLE

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

Type -> (string)

The type of ParameterListControl .

Possible values:

• MULTI_SELECT
• SINGLE_SELECT

SelectableValues -> (structure)

A list of selectable values that are used in a control.

Values -> (list)

The values that are used in ParameterSelectableValues .

Constraints:

• max: 50000

(string)

LinkToDataSetColumn -> (structure)

The column identifier that fetches values from the data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CascadingControlConfiguration -> (structure)

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

SourceControls -> (list)

A list of source controls that determine the values that are used in the current control.

Constraints:

• max: 200

(structure)

The source controls that are used in a CascadingControlConfiguration .

SourceSheetControlId -> (string)

The source sheet control ID of a CascadingControlSource .

ColumnToMatch -> (structure)

The column identifier that determines which column to look up for the source sheet control.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Dropdown -> (structure)

A control to display a dropdown list with buttons that are used to select a single value.

ParameterControlId -> (string) [required]

The ID of the ParameterDropDownControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the ParameterDropDownControl .

Constraints:

• min: 1
• max: 2048

SourceParameterName -> (string) [required]

The source parameter name of the ParameterDropDownControl .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

DisplayOptions -> (structure)

The display options of a control.

SelectAllOptions -> (structure)

The configuration of the Select all options in a dropdown control.

Visibility -> (string)

The visibility configuration of the Select all options in a list control.

Possible values:

• HIDDEN
• VISIBLE

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

Type -> (string)

The type parameter name of the ParameterDropDownControl .

Possible values:

• MULTI_SELECT
• SINGLE_SELECT

SelectableValues -> (structure)

A list of selectable values that are used in a control.

Values -> (list)

The values that are used in ParameterSelectableValues .

Constraints:

• max: 50000

(string)

LinkToDataSetColumn -> (structure)

The column identifier that fetches values from the data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CascadingControlConfiguration -> (structure)

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

SourceControls -> (list)

A list of source controls that determine the values that are used in the current control.

Constraints:

• max: 200

(structure)

The source controls that are used in a CascadingControlConfiguration .

SourceSheetControlId -> (string)

The source sheet control ID of a CascadingControlSource .

ColumnToMatch -> (structure)

The column identifier that determines which column to look up for the source sheet control.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CommitMode -> (string)

The visibility configuration of the Apply button on a ParameterDropDownControl .

Possible values:

• AUTO
• MANUAL

TextField -> (structure)

A control to display a text box that is used to enter a single entry.

ParameterControlId -> (string) [required]

The ID of the ParameterTextFieldControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the ParameterTextFieldControl .

Constraints:

• min: 1
• max: 2048

SourceParameterName -> (string) [required]

The source parameter name of the ParameterTextFieldControl .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

PlaceholderOptions -> (structure)

The configuration of the placeholder options in a text field control.

Visibility -> (string)

The visibility configuration of the placeholder options in a text control.

Possible values:

• HIDDEN
• VISIBLE

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

TextArea -> (structure)

A control to display a text box that is used to enter multiple entries.

ParameterControlId -> (string) [required]

The ID of the ParameterTextAreaControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the ParameterTextAreaControl .

Constraints:

• min: 1
• max: 2048

SourceParameterName -> (string) [required]

The source parameter name of the ParameterTextAreaControl .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Delimiter -> (string)

The delimiter that is used to separate the lines in text.

Constraints:

• min: 1
• max: 2048

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

PlaceholderOptions -> (structure)

The configuration of the placeholder options in a text area control.

Visibility -> (string)

The visibility configuration of the placeholder options in a text control.

Possible values:

• HIDDEN
• VISIBLE

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

Slider -> (structure)

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

ParameterControlId -> (string) [required]

The ID of the ParameterSliderControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the ParameterSliderControl .

Constraints:

• min: 1
• max: 2048

SourceParameterName -> (string) [required]

The source parameter name of the ParameterSliderControl .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

MaximumValue -> (double) [required]

The larger value that is displayed at the right of the slider.

MinimumValue -> (double) [required]

The smaller value that is displayed at the left of the slider.

StepSize -> (double) [required]

The number of increments that the slider bar is divided into.

FilterControls -> (list)

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide .

Constraints:

• max: 200

(structure)

The control of a filter that is used to interact with a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

DateTimePicker -> (structure)

A control from a date filter that is used to specify date and time.

FilterControlId -> (string) [required]

The ID of the FilterDateTimePickerControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the FilterDateTimePickerControl .

Constraints:

• min: 1
• max: 2048

SourceFilterId -> (string) [required]

The source filter ID of the FilterDateTimePickerControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

DateTimeFormat -> (string)

Customize how dates are formatted in controls.

Constraints:

• min: 1
• max: 128

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

HelperTextVisibility -> (string)

The helper text visibility of the DateTimePickerControlDisplayOptions .

Possible values:

• HIDDEN
• VISIBLE

DateIconVisibility -> (string)

The date icon visibility of the DateTimePickerControlDisplayOptions .

Possible values:

• HIDDEN
• VISIBLE

Type -> (string)

The type of the FilterDropDownControl . Choose one of the following options:

• MULTI_SELECT : The user can select multiple entries from a dropdown menu.
• SINGLE_SELECT : The user can select a single entry from a dropdown menu.

Possible values:

• SINGLE_VALUED
• DATE_RANGE

CommitMode -> (string)

The visibility configurationof the Apply button on a DateTimePickerControl .

Possible values:

• AUTO
• MANUAL

List -> (structure)

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

FilterControlId -> (string) [required]

The ID of the FilterListControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the FilterListControl .

Constraints:

• min: 1
• max: 2048

SourceFilterId -> (string) [required]

The source filter ID of the FilterListControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

DisplayOptions -> (structure)

The display options of a control.

SearchOptions -> (structure)

The configuration of the search options in a list control.

Visibility -> (string)

The visibility configuration of the search options in a list control.

Possible values:

• HIDDEN
• VISIBLE

SelectAllOptions -> (structure)

The configuration of the Select all options in a list control.

Visibility -> (string)

The visibility configuration of the Select all options in a list control.

Possible values:

• HIDDEN
• VISIBLE

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

Type -> (string)

The type of the FilterListControl . Choose one of the following options:

• MULTI_SELECT : The user can select multiple entries from the list.
• SINGLE_SELECT : The user can select a single entry from the list.

Possible values:

• MULTI_SELECT
• SINGLE_SELECT

SelectableValues -> (structure)

A list of selectable values that are used in a control.

Values -> (list)

The values that are used in the FilterSelectableValues .

Constraints:

• max: 50000

(string)

CascadingControlConfiguration -> (structure)

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

SourceControls -> (list)

A list of source controls that determine the values that are used in the current control.

Constraints:

• max: 200

(structure)

The source controls that are used in a CascadingControlConfiguration .

SourceSheetControlId -> (string)

The source sheet control ID of a CascadingControlSource .

ColumnToMatch -> (structure)

The column identifier that determines which column to look up for the source sheet control.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Dropdown -> (structure)

A control to display a dropdown list with buttons that are used to select a single value.

FilterControlId -> (string) [required]

The ID of the FilterDropDownControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the FilterDropDownControl .

Constraints:

• min: 1
• max: 2048

SourceFilterId -> (string) [required]

The source filter ID of the FilterDropDownControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

DisplayOptions -> (structure)

The display options of the FilterDropDownControl .

SelectAllOptions -> (structure)

The configuration of the Select all options in a dropdown control.

Visibility -> (string)

The visibility configuration of the Select all options in a list control.

Possible values:

• HIDDEN
• VISIBLE

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

Type -> (string)

The type of the FilterDropDownControl . Choose one of the following options:

• MULTI_SELECT : The user can select multiple entries from a dropdown menu.
• SINGLE_SELECT : The user can select a single entry from a dropdown menu.

Possible values:

• MULTI_SELECT
• SINGLE_SELECT

SelectableValues -> (structure)

A list of selectable values that are used in a control.

Values -> (list)

The values that are used in the FilterSelectableValues .

Constraints:

• max: 50000

(string)

CascadingControlConfiguration -> (structure)

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

SourceControls -> (list)

A list of source controls that determine the values that are used in the current control.

Constraints:

• max: 200

(structure)

The source controls that are used in a CascadingControlConfiguration .

SourceSheetControlId -> (string)

The source sheet control ID of a CascadingControlSource .

ColumnToMatch -> (structure)

The column identifier that determines which column to look up for the source sheet control.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CommitMode -> (string)

The visibility configuration of the Apply button on a FilterDropDownControl .

Possible values:

• AUTO
• MANUAL

TextField -> (structure)

A control to display a text box that is used to enter a single entry.

FilterControlId -> (string) [required]

The ID of the FilterTextFieldControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the FilterTextFieldControl .

Constraints:

• min: 1
• max: 2048

SourceFilterId -> (string) [required]

The source filter ID of the FilterTextFieldControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

PlaceholderOptions -> (structure)

The configuration of the placeholder options in a text field control.

Visibility -> (string)

The visibility configuration of the placeholder options in a text control.

Possible values:

• HIDDEN
• VISIBLE

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

TextArea -> (structure)

A control to display a text box that is used to enter multiple entries.

FilterControlId -> (string) [required]

The ID of the FilterTextAreaControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the FilterTextAreaControl .

Constraints:

• min: 1
• max: 2048

SourceFilterId -> (string) [required]

The source filter ID of the FilterTextAreaControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Delimiter -> (string)

The delimiter that is used to separate the lines in text.

Constraints:

• min: 1
• max: 2048

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

PlaceholderOptions -> (structure)

The configuration of the placeholder options in a text area control.

Visibility -> (string)

The visibility configuration of the placeholder options in a text control.

Possible values:

• HIDDEN
• VISIBLE

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

Slider -> (structure)

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

FilterControlId -> (string) [required]

The ID of the FilterSliderControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the FilterSliderControl .

Constraints:

• min: 1
• max: 2048

SourceFilterId -> (string) [required]

The source filter ID of the FilterSliderControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

Type -> (string)

The type of the FilterSliderControl . Choose one of the following options:

• SINGLE_POINT : Filter against(equals) a single data point.
• RANGE : Filter data that is in a specified range.

Possible values:

• SINGLE_POINT
• RANGE

MaximumValue -> (double) [required]

The larger value that is displayed at the right of the slider.

MinimumValue -> (double) [required]

The smaller value that is displayed at the left of the slider.

StepSize -> (double) [required]

The number of increments that the slider bar is divided into.

RelativeDateTime -> (structure)

A control from a date filter that is used to specify the relative date.

FilterControlId -> (string) [required]

The ID of the FilterTextAreaControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (string) [required]

The title of the FilterTextAreaControl .

Constraints:

• min: 1
• max: 2048

SourceFilterId -> (string) [required]

The source filter ID of the FilterTextAreaControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

DisplayOptions -> (structure)

The display options of a control.

TitleOptions -> (structure)

The options to configure the title visibility, name, and font size.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

DateTimeFormat -> (string)

Customize how dates are formatted in controls.

Constraints:

• min: 1
• max: 128

InfoIconLabelOptions -> (structure)

The configuration of info icon label options.

Visibility -> (string)

The visibility configuration of info icon label options.

Possible values:

• HIDDEN
• VISIBLE

InfoIconText -> (string)

The text content of info icon.

Constraints:

• min: 1
• max: 100

CommitMode -> (string)

The visibility configuration of the Apply button on a FilterRelativeDateTimeControl .

Possible values:

• AUTO
• MANUAL

CrossSheet -> (structure)

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

FilterControlId -> (string) [required]

The ID of the FilterCrossSheetControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

SourceFilterId -> (string) [required]

The source filter ID of the FilterCrossSheetControl .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

CascadingControlConfiguration -> (structure)

The values that are displayed in a control can be configured to only show values that are valid based on what’s selected in other controls.

SourceControls -> (list)

A list of source controls that determine the values that are used in the current control.

Constraints:

• max: 200

(structure)

The source controls that are used in a CascadingControlConfiguration .

SourceSheetControlId -> (string)

The source sheet control ID of a CascadingControlSource .

ColumnToMatch -> (structure)

The column identifier that determines which column to look up for the source sheet control.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Visuals -> (list)

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

Constraints:

• max: 50

(structure)

A visual displayed on a sheet in an analysis, dashboard, or template.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

TableVisual -> (structure)

A table visual.

For more information, see Using tables as visuals in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

TableAggregatedFieldWells -> (structure)

The aggregated field well for the table.

GroupBy -> (list)

The group by field well for a pivot table. Values are grouped by group by fields.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The values field well for a pivot table. Values are aggregated based on group by fields.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

TableUnaggregatedFieldWells -> (structure)

The unaggregated field well for the table.

Values -> (list)

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

Constraints:

• max: 201

(structure)

The unaggregated field for a table.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the UnaggregatedField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

FormatConfiguration -> (structure)

The format configuration of the field.

StringFormatConfiguration -> (structure)

Formatting configuration for string fields.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumberFormatConfiguration -> (structure)

Formatting configuration for number fields.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateTimeFormatConfiguration -> (structure)

Formatting configuration for DateTime fields.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SortConfiguration -> (structure)

The sort configuration for a TableVisual .

RowSort -> (list)

The field sort options for rows in the table.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

PaginationConfiguration -> (structure)

The pagination configuration (page size, page number) for the table.

PageSize -> (long) [required]

Indicates how many items render in one page.

PageNumber -> (long) [required]

Indicates the page number.

Constraints:

• min: 0

TableOptions -> (structure)

The table options for a table visual.

Orientation -> (string)

The orientation (vertical, horizontal) for a table.

Possible values:

• VERTICAL
• HORIZONTAL

HeaderStyle -> (structure)

The table cell style of a table header.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

CellStyle -> (structure)

The table cell style of table cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

RowAlternateColorOptions -> (structure)

The row alternate color options (widget status, row alternate colors) for a table.

Status -> (string)

Determines the widget status.

Possible values:

• ENABLED
• DISABLED

RowAlternateColors -> (list)

Determines the list of row alternate colors.

Constraints:

• max: 1

(string)

Constraints:

• pattern: ^#[A-F0-9]{6}$

UsePrimaryBackgroundColor -> (string)

The primary background color options for alternate rows.

Possible values:

• ENABLED
• DISABLED

TotalOptions -> (structure)

The total options for a table visual.

TotalsVisibility -> (string)

The visibility configuration for the total cells.

Possible values:

• HIDDEN
• VISIBLE

Placement -> (string)

The placement (start, end) for the total cells.

Possible values:

• START
• END
• AUTO

ScrollStatus -> (string)

The scroll status (pinned, scrolled) for the total cells.

Possible values:

• PINNED
• SCROLLED

CustomLabel -> (string)

The custom label string for the total cells.

TotalCellStyle -> (structure)

Cell styling options for the total cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

TotalAggregationOptions -> (list)

The total aggregation settings for each value field.

Constraints:

• max: 200

(structure)

The total aggregation settings map of a field id.

FieldId -> (string) [required]

The field id that’s associated with the total aggregation option.

Constraints:

• min: 1
• max: 512

TotalAggregationFunction -> (structure) [required]

The total aggregation function that you want to set for a specified field id.

SimpleTotalAggregationFunction -> (string)

A built in aggregation function for total values.

Possible values:

• DEFAULT
• SUM
• AVERAGE
• MIN
• MAX
• NONE

FieldOptions -> (structure)

The field options for a table visual.

SelectedFieldOptions -> (list)

The field options to be configured to a table.

Constraints:

• max: 201

(structure)

The options for a table field.

FieldId -> (string) [required]

The field ID for a table field.

Constraints:

• min: 1
• max: 512

Width -> (string)

The width for a table field.

CustomLabel -> (string)

The custom label for a table field.

Constraints:

• min: 1
• max: 2048

Visibility -> (string)

The visibility of a table field.

Possible values:

• HIDDEN
• VISIBLE

URLStyling -> (structure)

The URL configuration for a table field.

LinkConfiguration -> (structure)

The link configuration of a table field URL.

Target -> (string) [required]

The URL target (new tab, new window, same tab) for the table link configuration.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

Content -> (structure) [required]

The URL content (text, icon) for the table link configuration.

CustomTextContent -> (structure)

The custom text content (value, font configuration) for the table link content configuration.

Value -> (string)

The string value of the custom text content for the table URL link content.

FontConfiguration -> (structure) [required]

The font configuration of the custom text content for the table URL link content.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomIconContent -> (structure)

The custom icon content for the table link content configuration.

Icon -> (string)

The icon set type (link) of the custom icon content for table URL link content.

Possible values:

• LINK

ImageConfiguration -> (structure)

The image configuration of a table field URL.

SizingOptions -> (structure)

The sizing options for the table image configuration.

TableCellImageScalingConfiguration -> (string)

The cell scaling configuration of the sizing options for the table image configuration.

Possible values:

• FIT_TO_CELL_HEIGHT
• FIT_TO_CELL_WIDTH
• DO_NOT_SCALE

Order -> (list)

The order of the field IDs that are configured as field options for a table visual.

Constraints:

• max: 200

(string)

Constraints:

• min: 1
• max: 512

PinnedFieldOptions -> (structure)

The settings for the pinned columns of a table visual.

PinnedLeftFields -> (list)

A list of columns to be pinned to the left of a table visual.

Constraints:

• max: 201

(string)

Constraints:

• min: 1
• max: 512

TransposedTableOptions -> (list)

The TableOptions of a transposed table.

Constraints:

• max: 10001

(structure)

The column option of the transposed table.

ColumnIndex -> (integer)

The index of a columns in a transposed table. The index range is 0-9999.

Constraints:

• min: 0
• max: 9999

ColumnWidth -> (string)

The width of a column in a transposed table.

ColumnType -> (string) [required]

The column type of the column in a transposed table. Choose one of the following options:

• ROW_HEADER_COLUMN : Refers to the leftmost column of the row header in the transposed table.
• VALUE_COLUMN : Refers to all value columns in the transposed table.

Possible values:

• ROW_HEADER_COLUMN
• VALUE_COLUMN

PaginatedReportOptions -> (structure)

The paginated report options for a table visual.

VerticalOverflowVisibility -> (string)

The visibility of printing table overflow across pages.

Possible values:

• HIDDEN
• VISIBLE

OverflowColumnHeaderVisibility -> (string)

The visibility of repeating header rows on each page.

Possible values:

• HIDDEN
• VISIBLE

TableInlineVisualizations -> (list)

A collection of inline visualizations to display within a chart.

Constraints:

• max: 200

(structure)

The inline visualization of a specific type to display within a chart.

DataBars -> (structure)

The configuration of the inline visualization of the data bars within a chart.

FieldId -> (string) [required]

The field ID for the data bars options.

Constraints:

• min: 1
• max: 512

PositiveColor -> (string)

The color of the positive data bar.

Constraints:

• pattern: ^#[A-F0-9]{6}$

NegativeColor -> (string)

The color of the negative data bar.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

ConditionalFormatting -> (structure)

The conditional formatting for a PivotTableVisual .

ConditionalFormattingOptions -> (list)

Conditional formatting options for a PivotTableVisual .

Constraints:

• max: 500

(structure)

Conditional formatting options for a PivotTableVisual .

Cell -> (structure)

The cell conditional formatting option for a table.

FieldId -> (string) [required]

The field ID of the cell for conditional formatting.

Constraints:

• min: 1
• max: 512

TextFormat -> (structure)

The text format of the cell for conditional formatting.

BackgroundColor -> (structure)

The conditional formatting for the text background color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TextColor -> (structure)

The conditional formatting for the text color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Icon -> (structure)

The conditional formatting for the icon.

IconSet -> (structure)

Formatting configuration for icon set.

Expression -> (string) [required]

The expression that determines the formatting configuration for the icon set.

Constraints:

• min: 1
• max: 4096

IconSetType -> (string)

Determines the icon set type.

Possible values:

• PLUS_MINUS
• CHECK_X
• THREE_COLOR_ARROW
• THREE_GRAY_ARROW
• CARET_UP_MINUS_DOWN
• THREE_SHAPE
• THREE_CIRCLE
• FLAGS
• BARS
• FOUR_COLOR_ARROW
• FOUR_GRAY_ARROW

CustomCondition -> (structure)

Determines the custom condition for an icon set.

Expression -> (string) [required]

The expression that determines the condition of the icon set.

Constraints:

• min: 1
• max: 4096

IconOptions -> (structure) [required]

Custom icon options for an icon set.

Icon -> (string)

Determines the type of icon.

Possible values:

• CARET_UP
• CARET_DOWN
• PLUS
• MINUS
• ARROW_UP
• ARROW_DOWN
• ARROW_LEFT
• ARROW_UP_LEFT
• ARROW_DOWN_LEFT
• ARROW_RIGHT
• ARROW_UP_RIGHT
• ARROW_DOWN_RIGHT
• FACE_UP
• FACE_DOWN
• FACE_FLAT
• ONE_BAR
• TWO_BAR
• THREE_BAR
• CIRCLE
• TRIANGLE
• SQUARE
• FLAG
• THUMBS_UP
• THUMBS_DOWN
• CHECKMARK
• X

UnicodeIcon -> (string)

Determines the Unicode icon type.

Constraints:

• pattern: ^[^\u0000-\u00FF]$

Color -> (string)

Determines the color of the icon.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DisplayConfiguration -> (structure)

Determines the icon display configuration.

IconDisplayOption -> (string)

Determines the icon display configuration.

Possible values:

• ICON_ONLY

Row -> (structure)

The row conditional formatting option for a table.

BackgroundColor -> (structure)

The conditional formatting color (solid, gradient) of the background for a table row.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TextColor -> (structure)

The conditional formatting color (solid, gradient) of the text for a table row.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

PivotTableVisual -> (structure)

A pivot table.

For more information, see Using pivot tables in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

PivotTableAggregatedFieldWells -> (structure)

The aggregated field well for the pivot table.

Rows -> (list)

The rows field well for a pivot table. Values are grouped by rows fields.

Constraints:

• max: 40

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Columns -> (list)

The columns field well for a pivot table. Values are grouped by columns fields.

Constraints:

• max: 40

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

Constraints:

• max: 40

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

SortConfiguration -> (structure)

The sort configuration for a PivotTableVisual .

FieldSortOptions -> (list)

The field sort options for a pivot table sort configuration.

Constraints:

• max: 200

(structure)

The field sort options for a pivot table sort configuration.

FieldId -> (string) [required]

The field ID for the field sort options.

Constraints:

• min: 1
• max: 512

SortBy -> (structure) [required]

The sort by field for the field sort options.

Field -> (structure)

The field sort (field id, direction) for the pivot table sort by options.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

Column -> (structure)

The column sort (field id, direction) for the pivot table sort by options.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

DataPath -> (structure)

The data path sort (data path value, direction) for the pivot table sort by options.

Direction -> (string) [required]

Determines the sort direction.

Possible values:

• ASC
• DESC

SortPaths -> (list) [required]

The list of data paths that need to be sorted.

Constraints:

• max: 20

(structure)

The data path that needs to be sorted.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

TableOptions -> (structure)

The table options for a pivot table visual.

MetricPlacement -> (string)

The metric placement (row, column) options.

Possible values:

• ROW
• COLUMN

SingleMetricVisibility -> (string)

The visibility of the single metric options.

Possible values:

• HIDDEN
• VISIBLE

ColumnNamesVisibility -> (string)

The visibility of the column names.

Possible values:

• HIDDEN
• VISIBLE

ToggleButtonsVisibility -> (string)

Determines the visibility of the pivot table.

Possible values:

• HIDDEN
• VISIBLE

ColumnHeaderStyle -> (structure)

The table cell style of the column header.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

RowHeaderStyle -> (structure)

The table cell style of the row headers.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

CellStyle -> (structure)

The table cell style of cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

RowFieldNamesStyle -> (structure)

The table cell style of row field names.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

RowAlternateColorOptions -> (structure)

The row alternate color options (widget status, row alternate colors).

Status -> (string)

Determines the widget status.

Possible values:

• ENABLED
• DISABLED

RowAlternateColors -> (list)

Determines the list of row alternate colors.

Constraints:

• max: 1

(string)

Constraints:

• pattern: ^#[A-F0-9]{6}$

UsePrimaryBackgroundColor -> (string)

The primary background color options for alternate rows.

Possible values:

• ENABLED
• DISABLED

CollapsedRowDimensionsVisibility -> (string)

The visibility setting of a pivot table’s collapsed row dimension fields. If the value of this structure is HIDDEN , all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE .

Possible values:

• HIDDEN
• VISIBLE

RowsLayout -> (string)

The layout for the row dimension headers of a pivot table. Choose one of the following options.

• TABULAR : (Default) Each row field is displayed in a separate column.
• HIERARCHY : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

Possible values:

• TABULAR
• HIERARCHY

RowsLabelOptions -> (structure)

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY .

Visibility -> (string)

The visibility of the rows label.

Possible values:

• HIDDEN
• VISIBLE

CustomLabel -> (string)

The custom label string for the rows label.

Constraints:

• min: 1
• max: 1024

DefaultCellWidth -> (string)

The default cell width of the pivot table.

TotalOptions -> (structure)

The total options for a pivot table visual.

RowSubtotalOptions -> (structure)

The row subtotal options.

TotalsVisibility -> (string)

The visibility configuration for the subtotal cells.

Possible values:

• HIDDEN
• VISIBLE

CustomLabel -> (string)

The custom label string for the subtotal cells.

FieldLevel -> (string)

The field level (all, custom, last) for the subtotal cells.

Possible values:

• ALL
• CUSTOM
• LAST

FieldLevelOptions -> (list)

The optional configuration of subtotal cells.

Constraints:

• max: 100

(structure)

The optional configuration of subtotals cells.

FieldId -> (string)

The field ID of the subtotal options.

Constraints:

• min: 1
• max: 512

TotalCellStyle -> (structure)

The cell styling options for the subtotal cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

ValueCellStyle -> (structure)

The cell styling options for the subtotals of value cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

MetricHeaderCellStyle -> (structure)

The cell styling options for the subtotals of header cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

StyleTargets -> (list)

The style targets options for subtotals.

Constraints:

• max: 3

(structure)

The table style target.

CellType -> (string) [required]

The cell type of the table style target.

Possible values:

• TOTAL
• METRIC_HEADER
• VALUE

ColumnSubtotalOptions -> (structure)

The column subtotal options.

TotalsVisibility -> (string)

The visibility configuration for the subtotal cells.

Possible values:

• HIDDEN
• VISIBLE

CustomLabel -> (string)

The custom label string for the subtotal cells.

FieldLevel -> (string)

The field level (all, custom, last) for the subtotal cells.

Possible values:

• ALL
• CUSTOM
• LAST

FieldLevelOptions -> (list)

The optional configuration of subtotal cells.

Constraints:

• max: 100

(structure)

The optional configuration of subtotals cells.

FieldId -> (string)

The field ID of the subtotal options.

Constraints:

• min: 1
• max: 512

TotalCellStyle -> (structure)

The cell styling options for the subtotal cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

ValueCellStyle -> (structure)

The cell styling options for the subtotals of value cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

MetricHeaderCellStyle -> (structure)

The cell styling options for the subtotals of header cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

StyleTargets -> (list)

The style targets options for subtotals.

Constraints:

• max: 3

(structure)

The table style target.

CellType -> (string) [required]

The cell type of the table style target.

Possible values:

• TOTAL
• METRIC_HEADER
• VALUE

RowTotalOptions -> (structure)

The row total options.

TotalsVisibility -> (string)

The visibility configuration for the total cells.

Possible values:

• HIDDEN
• VISIBLE

Placement -> (string)

The placement (start, end) for the total cells.

Possible values:

• START
• END
• AUTO

ScrollStatus -> (string)

The scroll status (pinned, scrolled) for the total cells.

Possible values:

• PINNED
• SCROLLED

CustomLabel -> (string)

The custom label string for the total cells.

TotalCellStyle -> (structure)

The cell styling options for the total cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

ValueCellStyle -> (structure)

The cell styling options for the totals of value cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

MetricHeaderCellStyle -> (structure)

The cell styling options for the total of header cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

TotalAggregationOptions -> (list)

The total aggregation options for each value field.

Constraints:

• max: 200

(structure)

The total aggregation settings map of a field id.

FieldId -> (string) [required]

The field id that’s associated with the total aggregation option.

Constraints:

• min: 1
• max: 512

TotalAggregationFunction -> (structure) [required]

The total aggregation function that you want to set for a specified field id.

SimpleTotalAggregationFunction -> (string)

A built in aggregation function for total values.

Possible values:

• DEFAULT
• SUM
• AVERAGE
• MIN
• MAX
• NONE

ColumnTotalOptions -> (structure)

The column total options.

TotalsVisibility -> (string)

The visibility configuration for the total cells.

Possible values:

• HIDDEN
• VISIBLE

Placement -> (string)

The placement (start, end) for the total cells.

Possible values:

• START
• END
• AUTO

ScrollStatus -> (string)

The scroll status (pinned, scrolled) for the total cells.

Possible values:

• PINNED
• SCROLLED

CustomLabel -> (string)

The custom label string for the total cells.

TotalCellStyle -> (structure)

The cell styling options for the total cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

ValueCellStyle -> (structure)

The cell styling options for the totals of value cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

MetricHeaderCellStyle -> (structure)

The cell styling options for the total of header cells.

Visibility -> (string)

The visibility of the table cells.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the table cells.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

TextWrap -> (string)

The text wrap (none, wrap) for the table cells.

Possible values:

• NONE
• WRAP

HorizontalTextAlignment -> (string)

The horizontal text alignment (left, center, right, auto) for the table cells.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

VerticalTextAlignment -> (string)

The vertical text alignment (top, middle, bottom) for the table cells.

Possible values:

• TOP
• MIDDLE
• BOTTOM
• AUTO

BackgroundColor -> (string)

The background color for the table cells.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Height -> (integer)

The height color for the table cells.

Constraints:

• min: 8
• max: 500

Border -> (structure)

The borders for the table cells.

UniformBorder -> (structure)

Determines the options for uniform border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

SideSpecificBorder -> (structure)

Determines the options for side specific border.

InnerVertical -> (structure)

The table border options of the inner vertical border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

InnerHorizontal -> (structure)

The table border options of the inner horizontal border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Left -> (structure)

The table border options of the left border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Right -> (structure)

The table border options of the right border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Top -> (structure)

The table border options of the top border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

Bottom -> (structure)

The table border options of the bottom border.

Color -> (string)

The color of a table border.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Thickness -> (integer)

The thickness of a table border.

Constraints:

• min: 1
• max: 4

Style -> (string)

The style (none, solid) of a table border.

Possible values:

• NONE
• SOLID

TotalAggregationOptions -> (list)

The total aggregation options for each value field.

Constraints:

• max: 200

(structure)

The total aggregation settings map of a field id.

FieldId -> (string) [required]

The field id that’s associated with the total aggregation option.

Constraints:

• min: 1
• max: 512

TotalAggregationFunction -> (structure) [required]

The total aggregation function that you want to set for a specified field id.

SimpleTotalAggregationFunction -> (string)

A built in aggregation function for total values.

Possible values:

• DEFAULT
• SUM
• AVERAGE
• MIN
• MAX
• NONE

FieldOptions -> (structure)

The field options for a pivot table visual.

SelectedFieldOptions -> (list)

The selected field options for the pivot table field options.

Constraints:

• max: 100

(structure)

The selected field options for the pivot table field options.

FieldId -> (string) [required]

The field ID of the pivot table field.

Constraints:

• min: 1
• max: 512

CustomLabel -> (string)

The custom label of the pivot table field.

Constraints:

• min: 1
• max: 2048

Visibility -> (string)

The visibility of the pivot table field.

Possible values:

• HIDDEN
• VISIBLE

DataPathOptions -> (list)

The data path options for the pivot table field options.

Constraints:

• max: 100

(structure)

The data path options for the pivot table field options.

DataPathList -> (list) [required]

The list of data path values for the data path options.

Constraints:

• max: 20

(structure)

The data path that needs to be sorted.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Width -> (string)

The width of the data path option.

CollapseStateOptions -> (list)

The collapse state options for the pivot table field options.

(structure)

The collapse state options for the pivot table field options.

Target -> (structure) [required]

A tagged-union object that sets the collapse state.

FieldId -> (string)

The field ID of the pivot table that the collapse state needs to be set to.

FieldDataPathValues -> (list)

The data path of the pivot table’s header. Used to set the collapse state.

Constraints:

• max: 20

(structure)

The data path that needs to be sorted.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

State -> (string)

The state of the field target of a pivot table. Choose one of the following options:

• COLLAPSED
• EXPANDED

Possible values:

• COLLAPSED
• EXPANDED

PaginatedReportOptions -> (structure)

The paginated report options for a pivot table visual.

VerticalOverflowVisibility -> (string)

The visibility of the printing table overflow across pages.

Possible values:

• HIDDEN
• VISIBLE

OverflowColumnHeaderVisibility -> (string)

The visibility of the repeating header rows on each page.

Possible values:

• HIDDEN
• VISIBLE

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

ConditionalFormatting -> (structure)

The conditional formatting for a PivotTableVisual .

ConditionalFormattingOptions -> (list)

Conditional formatting options for a PivotTableVisual .

Constraints:

• max: 500

(structure)

Conditional formatting options for a PivotTableVisual .

Cell -> (structure)

The cell conditional formatting option for a pivot table.

FieldId -> (string) [required]

The field ID of the cell for conditional formatting.

Constraints:

• min: 1
• max: 512

TextFormat -> (structure)

The text format of the cell for conditional formatting.

BackgroundColor -> (structure)

The conditional formatting for the text background color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TextColor -> (structure)

The conditional formatting for the text color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Icon -> (structure)

The conditional formatting for the icon.

IconSet -> (structure)

Formatting configuration for icon set.

Expression -> (string) [required]

The expression that determines the formatting configuration for the icon set.

Constraints:

• min: 1
• max: 4096

IconSetType -> (string)

Determines the icon set type.

Possible values:

• PLUS_MINUS
• CHECK_X
• THREE_COLOR_ARROW
• THREE_GRAY_ARROW
• CARET_UP_MINUS_DOWN
• THREE_SHAPE
• THREE_CIRCLE
• FLAGS
• BARS
• FOUR_COLOR_ARROW
• FOUR_GRAY_ARROW

CustomCondition -> (structure)

Determines the custom condition for an icon set.

Expression -> (string) [required]

The expression that determines the condition of the icon set.

Constraints:

• min: 1
• max: 4096

IconOptions -> (structure) [required]

Custom icon options for an icon set.

Icon -> (string)

Determines the type of icon.

Possible values:

• CARET_UP
• CARET_DOWN
• PLUS
• MINUS
• ARROW_UP
• ARROW_DOWN
• ARROW_LEFT
• ARROW_UP_LEFT
• ARROW_DOWN_LEFT
• ARROW_RIGHT
• ARROW_UP_RIGHT
• ARROW_DOWN_RIGHT
• FACE_UP
• FACE_DOWN
• FACE_FLAT
• ONE_BAR
• TWO_BAR
• THREE_BAR
• CIRCLE
• TRIANGLE
• SQUARE
• FLAG
• THUMBS_UP
• THUMBS_DOWN
• CHECKMARK
• X

UnicodeIcon -> (string)

Determines the Unicode icon type.

Constraints:

• pattern: ^[^\u0000-\u00FF]$

Color -> (string)

Determines the color of the icon.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DisplayConfiguration -> (structure)

Determines the icon display configuration.

IconDisplayOption -> (string)

Determines the icon display configuration.

Possible values:

• ICON_ONLY

Scope -> (structure)

The scope of the cell for conditional formatting.

Role -> (string)

The role (field, field total, grand total) of the cell for conditional formatting.

Possible values:

• FIELD
• FIELD_TOTAL
• GRAND_TOTAL

Scopes -> (list)

A list of cell scopes for conditional formatting.

Constraints:

• max: 3

(structure)

The scope of the cell for conditional formatting.

Role -> (string)

The role (field, field total, grand total) of the cell for conditional formatting.

Possible values:

• FIELD
• FIELD_TOTAL
• GRAND_TOTAL

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

BarChartVisual -> (structure)

A bar chart.

For more information, see Using bar charts in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

BarChartAggregatedFieldWells -> (structure)

The aggregated field wells of a bar chart.

Category -> (list)

The category (y-axis) field well of a bar chart.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The value field wells of a bar chart. Values are aggregated by category.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Colors -> (list)

The color (group/color) field well of a bar chart.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SmallMultiples -> (list)

The small multiples field well of a bar chart.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SortConfiguration -> (structure)

The sort configuration of a BarChartVisual .

CategorySort -> (list)

The sort configuration of category fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

CategoryItemsLimit -> (structure)

The limit on the number of categories displayed in a bar chart.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

ColorSort -> (list)

The sort configuration of color fields in a bar chart.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

ColorItemsLimit -> (structure)

The limit on the number of values displayed in a bar chart.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

SmallMultiplesSort -> (list)

The sort configuration of the small multiples field.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

SmallMultiplesLimitConfiguration -> (structure)

The limit on the number of small multiples panels that are displayed.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

Orientation -> (string)

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

• HORIZONTAL : Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
• VERTICAL : Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

Possible values:

• HORIZONTAL
• VERTICAL

BarsArrangement -> (string)

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

Possible values:

• CLUSTERED
• STACKED
• STACKED_PERCENT

VisualPalette -> (structure)

The palette (chart color) display setup of the visual.

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

SmallMultiplesOptions -> (structure)

The small multiples setup for the visual.

MaxVisibleRows -> (long)

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

Constraints:

• min: 1
• max: 10

MaxVisibleColumns -> (long)

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

Constraints:

• min: 1
• max: 10

PanelConfiguration -> (structure)

Configures the display options for each small multiples panel.

Title -> (structure)

Configures the title display within each small multiples panel.

Visibility -> (string)

Determines whether or not panel titles are displayed.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

HorizontalTextAlignment -> (string)

Sets the horizontal text alignment of the title within each panel.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

BorderVisibility -> (string)

Determines whether or not each panel displays a border.

Possible values:

• HIDDEN
• VISIBLE

BorderThickness -> (string)

Sets the line thickness of panel borders.

BorderStyle -> (string)

Sets the line style of panel borders.

Possible values:

• SOLID
• DASHED
• DOTTED

BorderColor -> (string)

Sets the line color of panel borders.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

GutterVisibility -> (string)

Determines whether or not negative space between sibling panels is rendered.

Possible values:

• HIDDEN
• VISIBLE

GutterSpacing -> (string)

Sets the total amount of negative space to display between sibling panels.

BackgroundVisibility -> (string)

Determines whether or not a background for each small multiples panel is rendered.

Possible values:

• HIDDEN
• VISIBLE

BackgroundColor -> (string)

Sets the background color for each panel.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

XAxis -> (structure)

The properties of a small multiples X axis.

Scale -> (string)

Determines whether scale of the axes are shared or independent. The default value is SHARED .

Possible values:

• SHARED
• INDEPENDENT

Placement -> (string)

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

Possible values:

• OUTSIDE
• INSIDE

YAxis -> (structure)

The properties of a small multiples Y axis.

Scale -> (string)

Determines whether scale of the axes are shared or independent. The default value is SHARED .

Possible values:

• SHARED
• INDEPENDENT

Placement -> (string)

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

Possible values:

• OUTSIDE
• INSIDE

CategoryAxis -> (structure)

The label display options (grid line, range, scale, axis step) for bar chart category.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

CategoryLabelOptions -> (structure)

The label options (label text, label visibility and sort icon visibility) for a bar chart.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ValueAxis -> (structure)

The label display options (grid line, range, scale, axis step) for a bar chart value.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

ValueLabelOptions -> (structure)

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColorLabelOptions -> (structure)

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

DataLabels -> (structure)

The options that determine if visual data labels are displayed.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

Tooltip -> (structure)

The tooltip display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ReferenceLines -> (list)

The reference line setup of the visual.

Constraints:

• max: 20

(structure)

The reference line visual display options.

Status -> (string)

The status of the reference line. Choose one of the following options:

• ENABLE
• DISABLE

Possible values:

• ENABLED
• DISABLED

DataConfiguration -> (structure) [required]

The data configuration of the reference line.

StaticConfiguration -> (structure)

The static data configuration of the reference line data configuration.

Value -> (double) [required]

The double input of the static data.

DynamicConfiguration -> (structure)

The dynamic configuration of the reference line data configuration.

Column -> (structure) [required]

The column that the dynamic data targets.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

MeasureAggregationFunction -> (structure)

The aggregation function that is used in the dynamic data.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

Calculation -> (structure) [required]

The calculation that is used in the dynamic data.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

AxisBinding -> (string)

The axis binding type of the reference line. Choose one of the following options:

• PrimaryY
• SecondaryY

Possible values:

• PRIMARY_YAXIS
• SECONDARY_YAXIS

SeriesType -> (string)

The series type of the reference line data configuration. Choose one of the following options:

• BAR
• LINE

Possible values:

• BAR
• LINE

StyleConfiguration -> (structure)

The style configuration of the reference line.

Pattern -> (string)

The pattern type of the line style. Choose one of the following options:

• SOLID
• DASHED
• DOTTED

Possible values:

• SOLID
• DASHED
• DOTTED

Color -> (string)

The hex color of the reference line.

Constraints:

• pattern: ^#[A-F0-9]{6}$

LabelConfiguration -> (structure)

The label configuration of the reference line.

ValueLabelConfiguration -> (structure)

The value label configuration of the label in a reference line.

RelativePosition -> (string)

The relative position of the value label. Choose one of the following options:

• BEFORE_CUSTOM_LABEL
• AFTER_CUSTOM_LABEL

Possible values:

• BEFORE_CUSTOM_LABEL
• AFTER_CUSTOM_LABEL

FormatConfiguration -> (structure)

The format configuration of the value label.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CustomLabelConfiguration -> (structure)

The custom label configuration of the label in a reference line.

CustomLabel -> (string) [required]

The string text of the custom label.

Constraints:

• pattern: .*\S.*

FontConfiguration -> (structure)

The font configuration of the label in a reference line.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

FontColor -> (string)

The font color configuration of the label in a reference line.

Constraints:

• pattern: ^#[A-F0-9]{6}$

HorizontalPosition -> (string)

The horizontal position configuration of the label in a reference line. Choose one of the following options:

• LEFT
• CENTER
• RIGHT

Possible values:

• LEFT
• CENTER
• RIGHT

VerticalPosition -> (string)

The vertical position configuration of the label in a reference line. Choose one of the following options:

• ABOVE
• BELOW

Possible values:

• ABOVE
• BELOW

ContributionAnalysisDefaults -> (list)

The contribution analysis (anomaly configuration) setup of the visual.

Constraints:

• min: 1
• max: 200

(structure)

The contribution analysis visual display for a line, pie, or bar chart.

MeasureFieldId -> (string) [required]

The measure field that is used in the contribution analysis.

Constraints:

• min: 1
• max: 512

ContributorDimensions -> (list) [required]

The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .

Constraints:

• min: 1
• max: 4

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

KPIVisual -> (structure)

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration of a KPI visual.

FieldWells -> (structure)

The field well configuration of a KPI visual.

Values -> (list)

The value field wells of a KPI visual.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

TargetValues -> (list)

The target value field wells of a KPI visual.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

TrendGroups -> (list)

The trend group field wells of a KPI visual.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SortConfiguration -> (structure)

The sort configuration of a KPI visual.

TrendGroupSort -> (list)

The sort configuration of the trend group fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

KPIOptions -> (structure)

The options that determine the presentation of a KPI visual.

ProgressBar -> (structure)

The options that determine the presentation of the progress bar of a KPI visual.

Visibility -> (string)

The visibility of the progress bar.

Possible values:

• HIDDEN
• VISIBLE

TrendArrows -> (structure)

The options that determine the presentation of trend arrows in a KPI visual.

Visibility -> (string)

The visibility of the trend arrows.

Possible values:

• HIDDEN
• VISIBLE

SecondaryValue -> (structure)

The options that determine the presentation of the secondary value of a KPI visual.

Visibility -> (string)

Determines the visibility of the secondary value.

Possible values:

• HIDDEN
• VISIBLE

Comparison -> (structure)

The comparison configuration of a KPI visual.

ComparisonMethod -> (string)

The method of the comparison. Choose from the following options:

• DIFFERENCE
• PERCENT_DIFFERENCE
• PERCENT

Possible values:

• DIFFERENCE
• PERCENT_DIFFERENCE
• PERCENT

ComparisonFormat -> (structure)

The format of the comparison.

NumberDisplayFormatConfiguration -> (structure)

The number display format.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The percentage display format.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PrimaryValueDisplayType -> (string)

The options that determine the primary value display type.

Possible values:

• HIDDEN
• COMPARISON
• ACTUAL

PrimaryValueFontConfiguration -> (structure)

The options that determine the primary value font configuration.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

SecondaryValueFontConfiguration -> (structure)

The options that determine the secondary value font configuration.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

Sparkline -> (structure)

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

Visibility -> (string)

The visibility of the sparkline.

Possible values:

• HIDDEN
• VISIBLE

Type -> (string) [required]

The type of the sparkline.

Possible values:

• LINE
• AREA

Color -> (string)

The color of the sparkline.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TooltipVisibility -> (string)

The tooltip visibility of the sparkline.

Possible values:

• HIDDEN
• VISIBLE

VisualLayoutOptions -> (structure)

The options that determine the layout a KPI visual.

StandardLayout -> (structure)

The standard layout of the KPI visual.

Type -> (string) [required]

The standard layout type.

Possible values:

• CLASSIC
• VERTICAL

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

ConditionalFormatting -> (structure)

The conditional formatting of a KPI visual.

ConditionalFormattingOptions -> (list)

The conditional formatting options of a KPI visual.

Constraints:

• max: 100

(structure)

The conditional formatting options of a KPI visual.

PrimaryValue -> (structure)

The conditional formatting for the primary value of a KPI visual.

TextColor -> (structure)

The conditional formatting of the primary value’s text color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Icon -> (structure)

The conditional formatting of the primary value’s icon.

IconSet -> (structure)

Formatting configuration for icon set.

Expression -> (string) [required]

The expression that determines the formatting configuration for the icon set.

Constraints:

• min: 1
• max: 4096

IconSetType -> (string)

Determines the icon set type.

Possible values:

• PLUS_MINUS
• CHECK_X
• THREE_COLOR_ARROW
• THREE_GRAY_ARROW
• CARET_UP_MINUS_DOWN
• THREE_SHAPE
• THREE_CIRCLE
• FLAGS
• BARS
• FOUR_COLOR_ARROW
• FOUR_GRAY_ARROW

CustomCondition -> (structure)

Determines the custom condition for an icon set.

Expression -> (string) [required]

The expression that determines the condition of the icon set.

Constraints:

• min: 1
• max: 4096

IconOptions -> (structure) [required]

Custom icon options for an icon set.

Icon -> (string)

Determines the type of icon.

Possible values:

• CARET_UP
• CARET_DOWN
• PLUS
• MINUS
• ARROW_UP
• ARROW_DOWN
• ARROW_LEFT
• ARROW_UP_LEFT
• ARROW_DOWN_LEFT
• ARROW_RIGHT
• ARROW_UP_RIGHT
• ARROW_DOWN_RIGHT
• FACE_UP
• FACE_DOWN
• FACE_FLAT
• ONE_BAR
• TWO_BAR
• THREE_BAR
• CIRCLE
• TRIANGLE
• SQUARE
• FLAG
• THUMBS_UP
• THUMBS_DOWN
• CHECKMARK
• X

UnicodeIcon -> (string)

Determines the Unicode icon type.

Constraints:

• pattern: ^[^\u0000-\u00FF]$

Color -> (string)

Determines the color of the icon.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DisplayConfiguration -> (structure)

Determines the icon display configuration.

IconDisplayOption -> (string)

Determines the icon display configuration.

Possible values:

• ICON_ONLY

ProgressBar -> (structure)

The conditional formatting for the progress bar of a KPI visual.

ForegroundColor -> (structure)

The conditional formatting of the progress bar’s foreground color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ActualValue -> (structure)

The conditional formatting for the actual value of a KPI visual.

TextColor -> (structure)

The conditional formatting of the actual value’s text color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Icon -> (structure)

The conditional formatting of the actual value’s icon.

IconSet -> (structure)

Formatting configuration for icon set.

Expression -> (string) [required]

The expression that determines the formatting configuration for the icon set.

Constraints:

• min: 1
• max: 4096

IconSetType -> (string)

Determines the icon set type.

Possible values:

• PLUS_MINUS
• CHECK_X
• THREE_COLOR_ARROW
• THREE_GRAY_ARROW
• CARET_UP_MINUS_DOWN
• THREE_SHAPE
• THREE_CIRCLE
• FLAGS
• BARS
• FOUR_COLOR_ARROW
• FOUR_GRAY_ARROW

CustomCondition -> (structure)

Determines the custom condition for an icon set.

Expression -> (string) [required]

The expression that determines the condition of the icon set.

Constraints:

• min: 1
• max: 4096

IconOptions -> (structure) [required]

Custom icon options for an icon set.

Icon -> (string)

Determines the type of icon.

Possible values:

• CARET_UP
• CARET_DOWN
• PLUS
• MINUS
• ARROW_UP
• ARROW_DOWN
• ARROW_LEFT
• ARROW_UP_LEFT
• ARROW_DOWN_LEFT
• ARROW_RIGHT
• ARROW_UP_RIGHT
• ARROW_DOWN_RIGHT
• FACE_UP
• FACE_DOWN
• FACE_FLAT
• ONE_BAR
• TWO_BAR
• THREE_BAR
• CIRCLE
• TRIANGLE
• SQUARE
• FLAG
• THUMBS_UP
• THUMBS_DOWN
• CHECKMARK
• X

UnicodeIcon -> (string)

Determines the Unicode icon type.

Constraints:

• pattern: ^[^\u0000-\u00FF]$

Color -> (string)

Determines the color of the icon.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DisplayConfiguration -> (structure)

Determines the icon display configuration.

IconDisplayOption -> (string)

Determines the icon display configuration.

Possible values:

• ICON_ONLY

ComparisonValue -> (structure)

The conditional formatting for the comparison value of a KPI visual.

TextColor -> (structure)

The conditional formatting of the comparison value’s text color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Icon -> (structure)

The conditional formatting of the comparison value’s icon.

IconSet -> (structure)

Formatting configuration for icon set.

Expression -> (string) [required]

The expression that determines the formatting configuration for the icon set.

Constraints:

• min: 1
• max: 4096

IconSetType -> (string)

Determines the icon set type.

Possible values:

• PLUS_MINUS
• CHECK_X
• THREE_COLOR_ARROW
• THREE_GRAY_ARROW
• CARET_UP_MINUS_DOWN
• THREE_SHAPE
• THREE_CIRCLE
• FLAGS
• BARS
• FOUR_COLOR_ARROW
• FOUR_GRAY_ARROW

CustomCondition -> (structure)

Determines the custom condition for an icon set.

Expression -> (string) [required]

The expression that determines the condition of the icon set.

Constraints:

• min: 1
• max: 4096

IconOptions -> (structure) [required]

Custom icon options for an icon set.

Icon -> (string)

Determines the type of icon.

Possible values:

• CARET_UP
• CARET_DOWN
• PLUS
• MINUS
• ARROW_UP
• ARROW_DOWN
• ARROW_LEFT
• ARROW_UP_LEFT
• ARROW_DOWN_LEFT
• ARROW_RIGHT
• ARROW_UP_RIGHT
• ARROW_DOWN_RIGHT
• FACE_UP
• FACE_DOWN
• FACE_FLAT
• ONE_BAR
• TWO_BAR
• THREE_BAR
• CIRCLE
• TRIANGLE
• SQUARE
• FLAG
• THUMBS_UP
• THUMBS_DOWN
• CHECKMARK
• X

UnicodeIcon -> (string)

Determines the Unicode icon type.

Constraints:

• pattern: ^[^\u0000-\u00FF]$

Color -> (string)

Determines the color of the icon.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DisplayConfiguration -> (structure)

Determines the icon display configuration.

IconDisplayOption -> (string)

Determines the icon display configuration.

Possible values:

• ICON_ONLY

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

PieChartVisual -> (structure)

A pie or donut chart.

For more information, see Using pie charts in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration of a pie chart.

FieldWells -> (structure)

The field wells of the visual.

PieChartAggregatedFieldWells -> (structure)

The field well configuration of a pie chart.

Category -> (list)

The category (group/color) field wells of a pie chart.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The value field wells of a pie chart. Values are aggregated based on categories.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

SmallMultiples -> (list)

The small multiples field well of a pie chart.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SortConfiguration -> (structure)

The sort configuration of a pie chart.

CategorySort -> (list)

The sort configuration of the category fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

CategoryItemsLimit -> (structure)

The limit on the number of categories that are displayed in a pie chart.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

SmallMultiplesSort -> (list)

The sort configuration of the small multiples field.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

SmallMultiplesLimitConfiguration -> (structure)

The limit on the number of small multiples panels that are displayed.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

DonutOptions -> (structure)

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

ArcOptions -> (structure)

The option for define the arc of the chart shape. Valid values are as follows:

• WHOLE - A pie chart
• SMALL - A small-sized donut chart
• MEDIUM - A medium-sized donut chart
• LARGE - A large-sized donut chart

ArcThickness -> (string)

The arc thickness of a GaugeChartVisual .

Possible values:

• SMALL
• MEDIUM
• LARGE
• WHOLE

DonutCenterOptions -> (structure)

The label options of the label that is displayed in the center of a donut chart. This option isn’t available for pie charts.

LabelVisibility -> (string)

Determines the visibility of the label in a donut chart. In the Quick Sight console, this option is called 'Show total' .

Possible values:

• HIDDEN
• VISIBLE

SmallMultiplesOptions -> (structure)

The small multiples setup for the visual.

MaxVisibleRows -> (long)

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

Constraints:

• min: 1
• max: 10

MaxVisibleColumns -> (long)

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

Constraints:

• min: 1
• max: 10

PanelConfiguration -> (structure)

Configures the display options for each small multiples panel.

Title -> (structure)

Configures the title display within each small multiples panel.

Visibility -> (string)

Determines whether or not panel titles are displayed.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

HorizontalTextAlignment -> (string)

Sets the horizontal text alignment of the title within each panel.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

BorderVisibility -> (string)

Determines whether or not each panel displays a border.

Possible values:

• HIDDEN
• VISIBLE

BorderThickness -> (string)

Sets the line thickness of panel borders.

BorderStyle -> (string)

Sets the line style of panel borders.

Possible values:

• SOLID
• DASHED
• DOTTED

BorderColor -> (string)

Sets the line color of panel borders.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

GutterVisibility -> (string)

Determines whether or not negative space between sibling panels is rendered.

Possible values:

• HIDDEN
• VISIBLE

GutterSpacing -> (string)

Sets the total amount of negative space to display between sibling panels.

BackgroundVisibility -> (string)

Determines whether or not a background for each small multiples panel is rendered.

Possible values:

• HIDDEN
• VISIBLE

BackgroundColor -> (string)

Sets the background color for each panel.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

XAxis -> (structure)

The properties of a small multiples X axis.

Scale -> (string)

Determines whether scale of the axes are shared or independent. The default value is SHARED .

Possible values:

• SHARED
• INDEPENDENT

Placement -> (string)

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

Possible values:

• OUTSIDE
• INSIDE

YAxis -> (structure)

The properties of a small multiples Y axis.

Scale -> (string)

Determines whether scale of the axes are shared or independent. The default value is SHARED .

Possible values:

• SHARED
• INDEPENDENT

Placement -> (string)

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

Possible values:

• OUTSIDE
• INSIDE

CategoryLabelOptions -> (structure)

The label options of the group/color that is displayed in a pie chart.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ValueLabelOptions -> (structure)

The label options for the value that is displayed in a pie chart.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

DataLabels -> (structure)

The options that determine if visual data labels are displayed.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

Tooltip -> (structure)

The tooltip display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

VisualPalette -> (structure)

The palette (chart color) display setup of the visual.

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

ContributionAnalysisDefaults -> (list)

The contribution analysis (anomaly configuration) setup of the visual.

Constraints:

• min: 1
• max: 200

(structure)

The contribution analysis visual display for a line, pie, or bar chart.

MeasureFieldId -> (string) [required]

The measure field that is used in the contribution analysis.

Constraints:

• min: 1
• max: 512

ContributorDimensions -> (list) [required]

The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .

Constraints:

• min: 1
• max: 4

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

GaugeChartVisual -> (structure)

A gauge chart.

For more information, see Using gauge charts in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration of a GaugeChartVisual .

FieldWells -> (structure)

The field well configuration of a GaugeChartVisual .

Values -> (list)

The value field wells of a GaugeChartVisual .

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

TargetValues -> (list)

The target value field wells of a GaugeChartVisual .

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

GaugeChartOptions -> (structure)

The options that determine the presentation of the GaugeChartVisual .

PrimaryValueDisplayType -> (string)

The options that determine the primary value display type.

Possible values:

• HIDDEN
• COMPARISON
• ACTUAL

Comparison -> (structure)

The comparison configuration of a GaugeChartVisual .

ComparisonMethod -> (string)

The method of the comparison. Choose from the following options:

• DIFFERENCE
• PERCENT_DIFFERENCE
• PERCENT

Possible values:

• DIFFERENCE
• PERCENT_DIFFERENCE
• PERCENT

ComparisonFormat -> (structure)

The format of the comparison.

NumberDisplayFormatConfiguration -> (structure)

The number display format.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The percentage display format.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

ArcAxis -> (structure)

The arc axis configuration of a GaugeChartVisual .

Range -> (structure)

The arc axis range of a GaugeChartVisual .

Min -> (double)

The minimum value of the arc axis range.

Max -> (double)

The maximum value of the arc axis range.

ReserveRange -> (integer)

The reserved range of the arc axis.

Arc -> (structure)

The arc configuration of a GaugeChartVisual .

ArcAngle -> (double)

The option that determines the arc angle of a GaugeChartVisual .

ArcThickness -> (string)

The options that determine the arc thickness of a GaugeChartVisual .

Possible values:

• SMALL
• MEDIUM
• LARGE

PrimaryValueFontConfiguration -> (structure)

The options that determine the primary value font configuration.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

DataLabels -> (structure)

The data label configuration of a GaugeChartVisual .

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

TooltipOptions -> (structure)

The tooltip configuration of a GaugeChartVisual .

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

VisualPalette -> (structure)

The visual palette configuration of a GaugeChartVisual .

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

ColorConfiguration -> (structure)

The color configuration of a GaugeChartVisual .

ForegroundColor -> (string)

The foreground color configuration of a GaugeChartVisual .

Constraints:

• pattern: ^#[A-F0-9]{6}$

BackgroundColor -> (string)

The background color configuration of a GaugeChartVisual .

Constraints:

• pattern: ^#[A-F0-9]{6}$

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

ConditionalFormatting -> (structure)

The conditional formatting of a GaugeChartVisual .

ConditionalFormattingOptions -> (list)

Conditional formatting options of a GaugeChartVisual .

Constraints:

• max: 100

(structure)

Conditional formatting options of a GaugeChartVisual .

PrimaryValue -> (structure)

The conditional formatting for the primary value of a GaugeChartVisual .

TextColor -> (structure)

The conditional formatting of the primary value text color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Icon -> (structure)

The conditional formatting of the primary value icon.

IconSet -> (structure)

Formatting configuration for icon set.

Expression -> (string) [required]

The expression that determines the formatting configuration for the icon set.

Constraints:

• min: 1
• max: 4096

IconSetType -> (string)

Determines the icon set type.

Possible values:

• PLUS_MINUS
• CHECK_X
• THREE_COLOR_ARROW
• THREE_GRAY_ARROW
• CARET_UP_MINUS_DOWN
• THREE_SHAPE
• THREE_CIRCLE
• FLAGS
• BARS
• FOUR_COLOR_ARROW
• FOUR_GRAY_ARROW

CustomCondition -> (structure)

Determines the custom condition for an icon set.

Expression -> (string) [required]

The expression that determines the condition of the icon set.

Constraints:

• min: 1
• max: 4096

IconOptions -> (structure) [required]

Custom icon options for an icon set.

Icon -> (string)

Determines the type of icon.

Possible values:

• CARET_UP
• CARET_DOWN
• PLUS
• MINUS
• ARROW_UP
• ARROW_DOWN
• ARROW_LEFT
• ARROW_UP_LEFT
• ARROW_DOWN_LEFT
• ARROW_RIGHT
• ARROW_UP_RIGHT
• ARROW_DOWN_RIGHT
• FACE_UP
• FACE_DOWN
• FACE_FLAT
• ONE_BAR
• TWO_BAR
• THREE_BAR
• CIRCLE
• TRIANGLE
• SQUARE
• FLAG
• THUMBS_UP
• THUMBS_DOWN
• CHECKMARK
• X

UnicodeIcon -> (string)

Determines the Unicode icon type.

Constraints:

• pattern: ^[^\u0000-\u00FF]$

Color -> (string)

Determines the color of the icon.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DisplayConfiguration -> (structure)

Determines the icon display configuration.

IconDisplayOption -> (string)

Determines the icon display configuration.

Possible values:

• ICON_ONLY

Arc -> (structure)

The options that determine the presentation of the arc of a GaugeChartVisual .

ForegroundColor -> (structure)

The conditional formatting of the arc foreground color.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

LineChartVisual -> (structure)

A line chart.

For more information, see Using line charts in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration of a line chart.

FieldWells -> (structure)

The field well configuration of a line chart.

LineChartAggregatedFieldWells -> (structure)

The field well configuration of a line chart.

Category -> (list)

The category field wells of a line chart. Values are grouped by category fields.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The value field wells of a line chart. Values are aggregated based on categories.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Colors -> (list)

The color field wells of a line chart. Values are grouped by category fields.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SmallMultiples -> (list)

The small multiples field well of a line chart.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SortConfiguration -> (structure)

The sort configuration of a line chart.

CategorySort -> (list)

The sort configuration of the category fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

CategoryItemsLimitConfiguration -> (structure)

The limit on the number of categories that are displayed in a line chart.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

ColorItemsLimitConfiguration -> (structure)

The limit on the number of lines that are displayed in a line chart.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

SmallMultiplesSort -> (list)

The sort configuration of the small multiples field.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

SmallMultiplesLimitConfiguration -> (structure)

The limit on the number of small multiples panels that are displayed.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

ForecastConfigurations -> (list)

The forecast configuration of a line chart.

Constraints:

• max: 10

(structure)

The forecast configuration that is used in a line chart’s display properties.

ForecastProperties -> (structure)

The forecast properties setup of a forecast in the line chart.

PeriodsForward -> (integer)

The periods forward setup of a forecast computation.

Constraints:

• min: 1
• max: 1000

PeriodsBackward -> (integer)

The periods backward setup of a forecast computation.

Constraints:

• min: 0
• max: 1000

UpperBoundary -> (double)

The upper boundary setup of a forecast computation.

LowerBoundary -> (double)

The lower boundary setup of a forecast computation.

PredictionInterval -> (integer)

The prediction interval setup of a forecast computation.

Constraints:

• min: 50
• max: 95

Seasonality -> (integer)

The seasonality setup of a forecast computation. Choose one of the following options:

• NULL : The input is set to NULL .
• NON_NULL : The input is set to a custom value.

Constraints:

• min: 1
• max: 180

Scenario -> (structure)

The forecast scenario of a forecast in the line chart.

WhatIfPointScenario -> (structure)

The what-if analysis forecast setup with the target date.

Date -> (timestamp) [required]

The date that you need the forecast results for.

Value -> (double) [required]

The target value that you want to meet for the provided date.

WhatIfRangeScenario -> (structure)

The what-if analysis forecast setup with the date range.

StartDate -> (timestamp) [required]

The start date in the date range that you need the forecast results for.

EndDate -> (timestamp) [required]

The end date in the date range that you need the forecast results for.

Value -> (double) [required]

The target value that you want to meet for the provided date range.

Type -> (string)

Determines the type of the line chart.

Possible values:

• LINE
• AREA
• STACKED_AREA

SmallMultiplesOptions -> (structure)

The small multiples setup for the visual.

MaxVisibleRows -> (long)

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

Constraints:

• min: 1
• max: 10

MaxVisibleColumns -> (long)

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

Constraints:

• min: 1
• max: 10

PanelConfiguration -> (structure)

Configures the display options for each small multiples panel.

Title -> (structure)

Configures the title display within each small multiples panel.

Visibility -> (string)

Determines whether or not panel titles are displayed.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

HorizontalTextAlignment -> (string)

Sets the horizontal text alignment of the title within each panel.

Possible values:

• LEFT
• CENTER
• RIGHT
• AUTO

BorderVisibility -> (string)

Determines whether or not each panel displays a border.

Possible values:

• HIDDEN
• VISIBLE

BorderThickness -> (string)

Sets the line thickness of panel borders.

BorderStyle -> (string)

Sets the line style of panel borders.

Possible values:

• SOLID
• DASHED
• DOTTED

BorderColor -> (string)

Sets the line color of panel borders.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

GutterVisibility -> (string)

Determines whether or not negative space between sibling panels is rendered.

Possible values:

• HIDDEN
• VISIBLE

GutterSpacing -> (string)

Sets the total amount of negative space to display between sibling panels.

BackgroundVisibility -> (string)

Determines whether or not a background for each small multiples panel is rendered.

Possible values:

• HIDDEN
• VISIBLE

BackgroundColor -> (string)

Sets the background color for each panel.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

XAxis -> (structure)

The properties of a small multiples X axis.

Scale -> (string)

Determines whether scale of the axes are shared or independent. The default value is SHARED .

Possible values:

• SHARED
• INDEPENDENT

Placement -> (string)

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

Possible values:

• OUTSIDE
• INSIDE

YAxis -> (structure)

The properties of a small multiples Y axis.

Scale -> (string)

Determines whether scale of the axes are shared or independent. The default value is SHARED .

Possible values:

• SHARED
• INDEPENDENT

Placement -> (string)

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

Possible values:

• OUTSIDE
• INSIDE

XAxisDisplayOptions -> (structure)

The options that determine the presentation of the x-axis.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

XAxisLabelOptions -> (structure)

The options that determine the presentation of the x-axis label.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

PrimaryYAxisDisplayOptions -> (structure)

The series axis configuration of a line chart.

AxisOptions -> (structure)

The options that determine the presentation of the line series axis.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

MissingDataConfigurations -> (list)

The configuration options that determine how missing data is treated during the rendering of a line chart.

Constraints:

• max: 100

(structure)

The configuration options that determine how missing data is treated during the rendering of a line chart.

TreatmentOption -> (string)

The treatment option that determines how missing data should be rendered. Choose from the following options:

• INTERPOLATE : Interpolate missing values between the prior and the next known value.
• SHOW_AS_ZERO : Show missing values as the value 0 .
• SHOW_AS_BLANK : Display a blank space when rendering missing data.

Possible values:

• INTERPOLATE
• SHOW_AS_ZERO
• SHOW_AS_BLANK

PrimaryYAxisLabelOptions -> (structure)

The options that determine the presentation of the y-axis label.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

SecondaryYAxisDisplayOptions -> (structure)

The series axis configuration of a line chart.

AxisOptions -> (structure)

The options that determine the presentation of the line series axis.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

MissingDataConfigurations -> (list)

The configuration options that determine how missing data is treated during the rendering of a line chart.

Constraints:

• max: 100

(structure)

The configuration options that determine how missing data is treated during the rendering of a line chart.

TreatmentOption -> (string)

The treatment option that determines how missing data should be rendered. Choose from the following options:

• INTERPOLATE : Interpolate missing values between the prior and the next known value.
• SHOW_AS_ZERO : Show missing values as the value 0 .
• SHOW_AS_BLANK : Display a blank space when rendering missing data.

Possible values:

• INTERPOLATE
• SHOW_AS_ZERO
• SHOW_AS_BLANK

SecondaryYAxisLabelOptions -> (structure)

The options that determine the presentation of the secondary y-axis label.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

SingleAxisOptions -> (structure)

The settings of a chart’s single axis configuration.

YAxisOptions -> (structure)

The Y axis options of a single axis configuration.

YAxis -> (string) [required]

The Y axis type to be used in the chart.

If you choose PRIMARY_Y_AXIS , the primary Y Axis is located on the leftmost vertical axis of the chart.

Possible values:

• PRIMARY_Y_AXIS

DefaultSeriesSettings -> (structure)

The options that determine the default presentation of all line series in LineChartVisual .

AxisBinding -> (string)

The axis to which you are binding all line series to.

Possible values:

• PRIMARY_YAXIS
• SECONDARY_YAXIS

LineStyleSettings -> (structure)

Line styles options for all line series in the visual.

LineVisibility -> (string)

Configuration option that determines whether to show the line for the series.

Possible values:

• HIDDEN
• VISIBLE

LineInterpolation -> (string)

Interpolation style for line series.

• LINEAR : Show as default, linear style.
• SMOOTH : Show as a smooth curve.
• STEPPED : Show steps in line.

Possible values:

• LINEAR
• SMOOTH
• STEPPED

LineStyle -> (string)

Line style for line series.

• SOLID : Show as a solid line.
• DOTTED : Show as a dotted line.
• DASHED : Show as a dashed line.

Possible values:

• SOLID
• DOTTED
• DASHED

LineWidth -> (string)

Width that determines the line thickness.

MarkerStyleSettings -> (structure)

Marker styles options for all line series in the visual.

MarkerVisibility -> (string)

Configuration option that determines whether to show the markers in the series.

Possible values:

• HIDDEN
• VISIBLE

MarkerShape -> (string)

Shape option for markers in the series.

• CIRCLE : Show marker as a circle.
• TRIANGLE : Show marker as a triangle.
• SQUARE : Show marker as a square.
• DIAMOND : Show marker as a diamond.
• ROUNDED_SQUARE : Show marker as a rounded square.

Possible values:

• CIRCLE
• TRIANGLE
• SQUARE
• DIAMOND
• ROUNDED_SQUARE

MarkerSize -> (string)

Size of marker in the series.

MarkerColor -> (string)

Color of marker in the series.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Series -> (list)

The series item configuration of a line chart.

Constraints:

• max: 2000

(structure)

The series item configuration of a line chart.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldSeriesItem -> (structure)

The field series item configuration of a line chart.

FieldId -> (string) [required]

The field ID of the field for which you are setting the axis binding.

Constraints:

• min: 1
• max: 512

AxisBinding -> (string) [required]

The axis that you are binding the field to.

Possible values:

• PRIMARY_YAXIS
• SECONDARY_YAXIS

Settings -> (structure)

The options that determine the presentation of line series associated to the field.

LineStyleSettings -> (structure)

Line styles options for a line series in LineChartVisual .

LineVisibility -> (string)

Configuration option that determines whether to show the line for the series.

Possible values:

• HIDDEN
• VISIBLE

LineInterpolation -> (string)

Interpolation style for line series.

• LINEAR : Show as default, linear style.
• SMOOTH : Show as a smooth curve.
• STEPPED : Show steps in line.

Possible values:

• LINEAR
• SMOOTH
• STEPPED

LineStyle -> (string)

Line style for line series.

• SOLID : Show as a solid line.
• DOTTED : Show as a dotted line.
• DASHED : Show as a dashed line.

Possible values:

• SOLID
• DOTTED
• DASHED

LineWidth -> (string)

Width that determines the line thickness.

MarkerStyleSettings -> (structure)

Marker styles options for a line series in LineChartVisual .

MarkerVisibility -> (string)

Configuration option that determines whether to show the markers in the series.

Possible values:

• HIDDEN
• VISIBLE

MarkerShape -> (string)

Shape option for markers in the series.

• CIRCLE : Show marker as a circle.
• TRIANGLE : Show marker as a triangle.
• SQUARE : Show marker as a square.
• DIAMOND : Show marker as a diamond.
• ROUNDED_SQUARE : Show marker as a rounded square.

Possible values:

• CIRCLE
• TRIANGLE
• SQUARE
• DIAMOND
• ROUNDED_SQUARE

MarkerSize -> (string)

Size of marker in the series.

MarkerColor -> (string)

Color of marker in the series.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DataFieldSeriesItem -> (structure)

The data field series item configuration of a line chart.

FieldId -> (string) [required]

The field ID of the field that you are setting the axis binding to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The field value of the field that you are setting the axis binding to.

AxisBinding -> (string) [required]

The axis that you are binding the field to.

Possible values:

• PRIMARY_YAXIS
• SECONDARY_YAXIS

Settings -> (structure)

The options that determine the presentation of line series associated to the field.

LineStyleSettings -> (structure)

Line styles options for a line series in LineChartVisual .

LineVisibility -> (string)

Configuration option that determines whether to show the line for the series.

Possible values:

• HIDDEN
• VISIBLE

LineInterpolation -> (string)

Interpolation style for line series.

• LINEAR : Show as default, linear style.
• SMOOTH : Show as a smooth curve.
• STEPPED : Show steps in line.

Possible values:

• LINEAR
• SMOOTH
• STEPPED

LineStyle -> (string)

Line style for line series.

• SOLID : Show as a solid line.
• DOTTED : Show as a dotted line.
• DASHED : Show as a dashed line.

Possible values:

• SOLID
• DOTTED
• DASHED

LineWidth -> (string)

Width that determines the line thickness.

MarkerStyleSettings -> (structure)

Marker styles options for a line series in LineChartVisual .

MarkerVisibility -> (string)

Configuration option that determines whether to show the markers in the series.

Possible values:

• HIDDEN
• VISIBLE

MarkerShape -> (string)

Shape option for markers in the series.

• CIRCLE : Show marker as a circle.
• TRIANGLE : Show marker as a triangle.
• SQUARE : Show marker as a square.
• DIAMOND : Show marker as a diamond.
• ROUNDED_SQUARE : Show marker as a rounded square.

Possible values:

• CIRCLE
• TRIANGLE
• SQUARE
• DIAMOND
• ROUNDED_SQUARE

MarkerSize -> (string)

Size of marker in the series.

MarkerColor -> (string)

Color of marker in the series.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Legend -> (structure)

The legend configuration of a line chart.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

DataLabels -> (structure)

The data label configuration of a line chart.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

ReferenceLines -> (list)

The reference lines configuration of a line chart.

Constraints:

• max: 20

(structure)

The reference line visual display options.

Status -> (string)

The status of the reference line. Choose one of the following options:

• ENABLE
• DISABLE

Possible values:

• ENABLED
• DISABLED

DataConfiguration -> (structure) [required]

The data configuration of the reference line.

StaticConfiguration -> (structure)

The static data configuration of the reference line data configuration.

Value -> (double) [required]

The double input of the static data.

DynamicConfiguration -> (structure)

The dynamic configuration of the reference line data configuration.

Column -> (structure) [required]

The column that the dynamic data targets.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

MeasureAggregationFunction -> (structure)

The aggregation function that is used in the dynamic data.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

Calculation -> (structure) [required]

The calculation that is used in the dynamic data.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

AxisBinding -> (string)

The axis binding type of the reference line. Choose one of the following options:

• PrimaryY
• SecondaryY

Possible values:

• PRIMARY_YAXIS
• SECONDARY_YAXIS

SeriesType -> (string)

The series type of the reference line data configuration. Choose one of the following options:

• BAR
• LINE

Possible values:

• BAR
• LINE

StyleConfiguration -> (structure)

The style configuration of the reference line.

Pattern -> (string)

The pattern type of the line style. Choose one of the following options:

• SOLID
• DASHED
• DOTTED

Possible values:

• SOLID
• DASHED
• DOTTED

Color -> (string)

The hex color of the reference line.

Constraints:

• pattern: ^#[A-F0-9]{6}$

LabelConfiguration -> (structure)

The label configuration of the reference line.

ValueLabelConfiguration -> (structure)

The value label configuration of the label in a reference line.

RelativePosition -> (string)

The relative position of the value label. Choose one of the following options:

• BEFORE_CUSTOM_LABEL
• AFTER_CUSTOM_LABEL

Possible values:

• BEFORE_CUSTOM_LABEL
• AFTER_CUSTOM_LABEL

FormatConfiguration -> (structure)

The format configuration of the value label.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CustomLabelConfiguration -> (structure)

The custom label configuration of the label in a reference line.

CustomLabel -> (string) [required]

The string text of the custom label.

Constraints:

• pattern: .*\S.*

FontConfiguration -> (structure)

The font configuration of the label in a reference line.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

FontColor -> (string)

The font color configuration of the label in a reference line.

Constraints:

• pattern: ^#[A-F0-9]{6}$

HorizontalPosition -> (string)

The horizontal position configuration of the label in a reference line. Choose one of the following options:

• LEFT
• CENTER
• RIGHT

Possible values:

• LEFT
• CENTER
• RIGHT

VerticalPosition -> (string)

The vertical position configuration of the label in a reference line. Choose one of the following options:

• ABOVE
• BELOW

Possible values:

• ABOVE
• BELOW

Tooltip -> (structure)

The tooltip configuration of a line chart.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ContributionAnalysisDefaults -> (list)

The default configuration of a line chart’s contribution analysis.

Constraints:

• min: 1
• max: 200

(structure)

The contribution analysis visual display for a line, pie, or bar chart.

MeasureFieldId -> (string) [required]

The measure field that is used in the contribution analysis.

Constraints:

• min: 1
• max: 512

ContributorDimensions -> (list) [required]

The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers .

Constraints:

• min: 1
• max: 4

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

VisualPalette -> (structure)

The visual palette configuration of a line chart.

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

HeatMapVisual -> (structure)

A heat map.

For more information, see Using heat maps in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration of a heat map.

FieldWells -> (structure)

The field wells of the visual.

HeatMapAggregatedFieldWells -> (structure)

The aggregated field wells of a heat map.

Rows -> (list)

The rows field well of a heat map.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Columns -> (list)

The columns field well of a heat map.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The values field well of a heat map.

Constraints:

• max: 1

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

SortConfiguration -> (structure)

The sort configuration of a heat map.

HeatMapRowSort -> (list)

The field sort configuration of the rows fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

HeatMapColumnSort -> (list)

The column sort configuration for heat map for columns that aren’t a part of a field well.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

HeatMapRowItemsLimitConfiguration -> (structure)

The limit on the number of rows that are displayed in a heat map.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

HeatMapColumnItemsLimitConfiguration -> (structure)

The limit on the number of columns that are displayed in a heat map.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

RowAxisDisplayOptions -> (structure)

The options that determine the presentation of the row axis label.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

RowLabelOptions -> (structure)

The label options of the row that is displayed in a heat map .

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnAxisDisplayOptions -> (structure)

The options that determine the presentation of the row axis label.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

ColumnLabelOptions -> (structure)

The label options of the column that is displayed in a heat map.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColorScale -> (structure)

The color options (gradient color, point of divergence) in a heat map.

Colors -> (list) [required]

Determines the list of colors that are applied to the visual.

Constraints:

• min: 2
• max: 3

(structure)

Determines the color that is applied to a particular data value.

Color -> (string)

The color that is applied to the data value.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DataValue -> (double)

The data value that the color is applied to.

ColorFillType -> (string) [required]

Determines the color fill type.

Possible values:

• DISCRETE
• GRADIENT

NullValueColor -> (structure)

Determines the color that is applied to null values.

Color -> (string)

The color that is applied to the data value.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DataValue -> (double)

The data value that the color is applied to.

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

DataLabels -> (structure)

The options that determine if visual data labels are displayed.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

Tooltip -> (structure)

The tooltip display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

TreeMapVisual -> (structure)

A tree map.

For more information, see Using tree maps in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

TreeMapAggregatedFieldWells -> (structure)

The aggregated field wells of a tree map.

Groups -> (list)

The group by field well of a tree map. Values are grouped based on group by fields.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Sizes -> (list)

The size field well of a tree map. Values are aggregated based on group by fields.

Constraints:

• max: 1

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Colors -> (list)

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

Constraints:

• max: 1

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

SortConfiguration -> (structure)

The sort configuration of a tree map.

TreeMapSort -> (list)

The sort configuration of group by fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TreeMapGroupItemsLimitConfiguration -> (structure)

The limit on the number of groups that are displayed.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

GroupLabelOptions -> (structure)

The label options (label text, label visibility) of the groups that are displayed in a tree map.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

SizeLabelOptions -> (structure)

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColorLabelOptions -> (structure)

The label options (label text, label visibility) for the colors displayed in a tree map.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColorScale -> (structure)

The color options (gradient color, point of divergence) of a tree map.

Colors -> (list) [required]

Determines the list of colors that are applied to the visual.

Constraints:

• min: 2
• max: 3

(structure)

Determines the color that is applied to a particular data value.

Color -> (string)

The color that is applied to the data value.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DataValue -> (double)

The data value that the color is applied to.

ColorFillType -> (string) [required]

Determines the color fill type.

Possible values:

• DISCRETE
• GRADIENT

NullValueColor -> (structure)

Determines the color that is applied to null values.

Color -> (string)

The color that is applied to the data value.

Constraints:

• pattern: ^#[A-F0-9]{6}$

DataValue -> (double)

The data value that the color is applied to.

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

DataLabels -> (structure)

The options that determine if visual data labels are displayed.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

Tooltip -> (structure)

The tooltip display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

GeospatialMapVisual -> (structure)

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

GeospatialMapAggregatedFieldWells -> (structure)

The aggregated field well for a geospatial map.

Geospatial -> (list)

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Colors -> (list)

The color field wells of a geospatial map.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

Tooltip -> (structure)

The tooltip display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

WindowOptions -> (structure)

The window options of the geospatial map.

Bounds -> (structure)

The bounds options (north, south, west, east) of the geospatial window options.

North -> (double) [required]

The latitude of the north bound of the geospatial coordinate bounds.

Constraints:

• min: -90
• max: 90

South -> (double) [required]

The latitude of the south bound of the geospatial coordinate bounds.

Constraints:

• min: -90
• max: 90

West -> (double) [required]

The longitude of the west bound of the geospatial coordinate bounds.

Constraints:

• min: -1800
• max: 1800

East -> (double) [required]

The longitude of the east bound of the geospatial coordinate bounds.

Constraints:

• min: -1800
• max: 1800

MapZoomMode -> (string)

The map zoom modes (manual, auto) of the geospatial window options.

Possible values:

• AUTO
• MANUAL

MapStyleOptions -> (structure)

The map style options of the geospatial map.

BaseMapStyle -> (string)

The base map style of the geospatial map.

Possible values:

• LIGHT_GRAY
• DARK_GRAY
• STREET
• IMAGERY

PointStyleOptions -> (structure)

The point style options of the geospatial map.

SelectedPointStyle -> (string)

The selected point styles (point, cluster) of the geospatial map.

Possible values:

• POINT
• CLUSTER
• HEATMAP

ClusterMarkerConfiguration -> (structure)

The cluster marker configuration of the geospatial point style.

ClusterMarker -> (structure)

The cluster marker that is a part of the cluster marker configuration.

SimpleClusterMarker -> (structure)

The simple cluster marker of the cluster marker.

Color -> (string)

The color of the simple cluster marker.

Constraints:

• pattern: ^#[A-F0-9]{6}$

HeatmapConfiguration -> (structure)

The heatmap configuration of the geospatial point style.

HeatmapColor -> (structure)

The color scale specification for the heatmap point style.

Colors -> (list)

The list of colors to be used in heatmap point style.

Constraints:

• min: 2
• max: 2

(structure)

The color to be used in the heatmap point style.

Color -> (string) [required]

The hex color to be used in the heatmap point style.

Constraints:

• pattern: ^#[A-F0-9]{6}$

VisualPalette -> (structure)

The visual display options for the visual palette.

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

FilledMapVisual -> (structure)

A filled map.

For more information, see Creating filled maps in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

FilledMapAggregatedFieldWells -> (structure)

The aggregated field well of the filled map.

Geospatial -> (list)

The aggregated location field well of the filled map. Values are grouped by location fields.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The aggregated color field well of a filled map. Values are aggregated based on location fields.

Constraints:

• max: 1

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

SortConfiguration -> (structure)

The sort configuration of a FilledMapVisual .

CategorySort -> (list)

The sort configuration of the location fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

Tooltip -> (structure)

The tooltip display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

WindowOptions -> (structure)

The window options of the filled map visual.

Bounds -> (structure)

The bounds options (north, south, west, east) of the geospatial window options.

North -> (double) [required]

The latitude of the north bound of the geospatial coordinate bounds.

Constraints:

• min: -90
• max: 90

South -> (double) [required]

The latitude of the south bound of the geospatial coordinate bounds.

Constraints:

• min: -90
• max: 90

West -> (double) [required]

The longitude of the west bound of the geospatial coordinate bounds.

Constraints:

• min: -1800
• max: 1800

East -> (double) [required]

The longitude of the east bound of the geospatial coordinate bounds.

Constraints:

• min: -1800
• max: 1800

MapZoomMode -> (string)

The map zoom modes (manual, auto) of the geospatial window options.

Possible values:

• AUTO
• MANUAL

MapStyleOptions -> (structure)

The map style options of the filled map visual.

BaseMapStyle -> (string)

The base map style of the geospatial map.

Possible values:

• LIGHT_GRAY
• DARK_GRAY
• STREET
• IMAGERY

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

ConditionalFormatting -> (structure)

The conditional formatting of a FilledMapVisual .

ConditionalFormattingOptions -> (list) [required]

Conditional formatting options of a FilledMapVisual .

Constraints:

• max: 200

(structure)

Conditional formatting options of a FilledMapVisual .

Shape -> (structure) [required]

The conditional formatting that determines the shape of the filled map.

FieldId -> (string) [required]

The field ID of the filled map shape.

Constraints:

• min: 1
• max: 512

Format -> (structure)

The conditional formatting that determines the background color of a filled map’s shape.

BackgroundColor -> (structure) [required]

The conditional formatting for the shape background color of a filled map visual.

Solid -> (structure)

Formatting configuration for solid color.

Expression -> (string) [required]

The expression that determines the formatting configuration for solid color.

Constraints:

• min: 1
• max: 4096

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Gradient -> (structure)

Formatting configuration for gradient color.

Expression -> (string) [required]

The expression that determines the formatting configuration for gradient color.

Constraints:

• min: 1
• max: 4096

Color -> (structure) [required]

Determines the color.

Stops -> (list)

The list of gradient color stops.

Constraints:

• max: 100

(structure)

Determines the gradient stop configuration.

GradientOffset -> (double) [required]

Determines gradient offset value.

DataValue -> (double)

Determines the data value.

Color -> (string)

Determines the color.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

LayerMapVisual -> (structure)

The properties for a layer map visual

VisualId -> (string) [required]

The ID of the visual.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title label options for a visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle label options for a visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

Legend -> (structure)

The options for the legend setup of a visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

MapLayers -> (list)

The geospatial layers to visualize on the map.

(structure)

The properties for a single geospatial layer.

LayerId -> (string) [required]

The ID of the layer.

LayerType -> (string)

The layer type.

Possible values:

• POINT
• LINE
• POLYGON

DataSource -> (structure)

The data source for the layer.

StaticFileDataSource -> (structure)

The static file data source properties for the geospatial data.

StaticFileId -> (string) [required]

The ID of the static file.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Label -> (string)

The label that is displayed for the layer.

Visibility -> (string)

The state of visibility for the layer.

Possible values:

• HIDDEN
• VISIBLE

LayerDefinition -> (structure)

The definition properties for a layer.

PointLayer -> (structure)

The definition for a point layer.

Style -> (structure) [required]

The visualization style for a point layer.

CircleSymbolStyle -> (structure)

The circle symbol style for a point layer.

FillColor -> (structure)

The color and opacity values for the fill color.

Solid -> (structure)

The visualization properties for the solid color.

Color -> (string) [required]

The color and opacity values for the color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

State -> (string)

Enables and disables the view state of the color.

Possible values:

• ENABLED
• DISABLED

Gradient -> (structure)

The visualization properties for the gradient color.

StepColors -> (list) [required]

A list of gradient step colors for the gradient.

Constraints:

• min: 2
• max: 3

(structure)

The gradient step color for a single step.

Color -> (string) [required]

The color and opacity values for the gradient step color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (double) [required]

The data value for the gradient step color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity for the gradient color.

Constraints:

• min: 0
• max: 1

Categorical -> (structure)

The visualization properties for the categorical color.

CategoryDataColors -> (list) [required]

A list of categorical data colors for each category.

(structure)

The categorical data color for a single category.

Color -> (string) [required]

The color and opacity values for the category data color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (string) [required]

The data value for the category data color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity of a categorical color.

Constraints:

• min: 0
• max: 1

StrokeColor -> (structure)

The color and opacity values for the stroke color.

Solid -> (structure)

The visualization properties for the solid color.

Color -> (string) [required]

The color and opacity values for the color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

State -> (string)

Enables and disables the view state of the color.

Possible values:

• ENABLED
• DISABLED

Gradient -> (structure)

The visualization properties for the gradient color.

StepColors -> (list) [required]

A list of gradient step colors for the gradient.

Constraints:

• min: 2
• max: 3

(structure)

The gradient step color for a single step.

Color -> (string) [required]

The color and opacity values for the gradient step color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (double) [required]

The data value for the gradient step color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity for the gradient color.

Constraints:

• min: 0
• max: 1

Categorical -> (structure)

The visualization properties for the categorical color.

CategoryDataColors -> (list) [required]

A list of categorical data colors for each category.

(structure)

The categorical data color for a single category.

Color -> (string) [required]

The color and opacity values for the category data color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (string) [required]

The data value for the category data color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity of a categorical color.

Constraints:

• min: 0
• max: 1

StrokeWidth -> (structure)

The width of the stroke (border).

LineWidth -> (double)

The positive value for the width of a line.

Constraints:

• min: 0

CircleRadius -> (structure)

The radius of the circle.

Radius -> (double)

The positive value for the radius of a circle.

Constraints:

• min: 0

LineLayer -> (structure)

The definition for a line layer.

Style -> (structure) [required]

The visualization style for a line layer.

LineSymbolStyle -> (structure)

The symbol style for a line style.

FillColor -> (structure)

The color and opacity values for the fill color.

Solid -> (structure)

The visualization properties for the solid color.

Color -> (string) [required]

The color and opacity values for the color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

State -> (string)

Enables and disables the view state of the color.

Possible values:

• ENABLED
• DISABLED

Gradient -> (structure)

The visualization properties for the gradient color.

StepColors -> (list) [required]

A list of gradient step colors for the gradient.

Constraints:

• min: 2
• max: 3

(structure)

The gradient step color for a single step.

Color -> (string) [required]

The color and opacity values for the gradient step color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (double) [required]

The data value for the gradient step color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity for the gradient color.

Constraints:

• min: 0
• max: 1

Categorical -> (structure)

The visualization properties for the categorical color.

CategoryDataColors -> (list) [required]

A list of categorical data colors for each category.

(structure)

The categorical data color for a single category.

Color -> (string) [required]

The color and opacity values for the category data color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (string) [required]

The data value for the category data color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity of a categorical color.

Constraints:

• min: 0
• max: 1

LineWidth -> (structure)

The width value for a line.

LineWidth -> (double)

The positive value for the width of a line.

Constraints:

• min: 0

PolygonLayer -> (structure)

The definition for a polygon layer.

Style -> (structure) [required]

The visualization style for a polygon layer.

PolygonSymbolStyle -> (structure)

The polygon symbol style for a polygon layer.

FillColor -> (structure)

The color and opacity values for the fill color.

Solid -> (structure)

The visualization properties for the solid color.

Color -> (string) [required]

The color and opacity values for the color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

State -> (string)

Enables and disables the view state of the color.

Possible values:

• ENABLED
• DISABLED

Gradient -> (structure)

The visualization properties for the gradient color.

StepColors -> (list) [required]

A list of gradient step colors for the gradient.

Constraints:

• min: 2
• max: 3

(structure)

The gradient step color for a single step.

Color -> (string) [required]

The color and opacity values for the gradient step color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (double) [required]

The data value for the gradient step color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity for the gradient color.

Constraints:

• min: 0
• max: 1

Categorical -> (structure)

The visualization properties for the categorical color.

CategoryDataColors -> (list) [required]

A list of categorical data colors for each category.

(structure)

The categorical data color for a single category.

Color -> (string) [required]

The color and opacity values for the category data color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (string) [required]

The data value for the category data color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity of a categorical color.

Constraints:

• min: 0
• max: 1

StrokeColor -> (structure)

The color and opacity values for the stroke color.

Solid -> (structure)

The visualization properties for the solid color.

Color -> (string) [required]

The color and opacity values for the color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

State -> (string)

Enables and disables the view state of the color.

Possible values:

• ENABLED
• DISABLED

Gradient -> (structure)

The visualization properties for the gradient color.

StepColors -> (list) [required]

A list of gradient step colors for the gradient.

Constraints:

• min: 2
• max: 3

(structure)

The gradient step color for a single step.

Color -> (string) [required]

The color and opacity values for the gradient step color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (double) [required]

The data value for the gradient step color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity for the gradient color.

Constraints:

• min: 0
• max: 1

Categorical -> (structure)

The visualization properties for the categorical color.

CategoryDataColors -> (list) [required]

A list of categorical data colors for each category.

(structure)

The categorical data color for a single category.

Color -> (string) [required]

The color and opacity values for the category data color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

DataValue -> (string) [required]

The data value for the category data color.

NullDataVisibility -> (string)

The state of visibility for null data.

Possible values:

• HIDDEN
• VISIBLE

NullDataSettings -> (structure)

The null data visualization settings.

SymbolStyle -> (structure) [required]

The symbol style for null data.

FillColor -> (string)

The color and opacity values for the fill color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeColor -> (string)

The color and opacity values for the stroke color.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

StrokeWidth -> (double)

The width of the border stroke.

Constraints:

• min: 0

DefaultOpacity -> (double)

The default opacity of a categorical color.

Constraints:

• min: 0
• max: 1

StrokeWidth -> (structure)

The width of the border stroke.

LineWidth -> (double)

The positive value for the width of a line.

Constraints:

• min: 0

Tooltip -> (structure)

The display options for the visual tooltip.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

JoinDefinition -> (structure)

The join definition properties for a layer.

ShapeKeyField -> (string)

The name of the field or property in the geospatial data source.

DatasetKeyField -> (structure)

The unaggregated field for a table.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the UnaggregatedField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

FormatConfiguration -> (structure)

The format configuration of the field.

StringFormatConfiguration -> (structure)

Formatting configuration for string fields.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumberFormatConfiguration -> (structure)

Formatting configuration for number fields.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateTimeFormatConfiguration -> (structure)

Formatting configuration for DateTime fields.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

ColorField -> (structure)

The geospatial color field for the join definition.

ColorDimensionsFields -> (list)

A list of color dimension fields.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

ColorValuesFields -> (list)

A list of color measure fields.

Constraints:

• max: 1

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Actions -> (list)

A list of custom actions for a layer.

Constraints:

• max: 10

(structure)

A layer custom action.

CustomActionId -> (string) [required]

The ID of the custom action.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the custom action.

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the LayerCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the LayerCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of LayerCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

MapState -> (structure)

The map state properties for the map.

Bounds -> (structure)

The bound options (north, south, west, east) of the geospatial window options.

North -> (double) [required]

The latitude of the north bound of the geospatial coordinate bounds.

Constraints:

• min: -90
• max: 90

South -> (double) [required]

The latitude of the south bound of the geospatial coordinate bounds.

Constraints:

• min: -90
• max: 90

West -> (double) [required]

The longitude of the west bound of the geospatial coordinate bounds.

Constraints:

• min: -1800
• max: 1800

East -> (double) [required]

The longitude of the east bound of the geospatial coordinate bounds.

Constraints:

• min: -1800
• max: 1800

MapNavigation -> (string)

Enables or disables map navigation for a map.

Possible values:

• ENABLED
• DISABLED

MapStyle -> (structure)

The map style properties for the map.

BaseMapStyle -> (string)

The selected base map style.

Possible values:

• LIGHT_GRAY
• DARK_GRAY
• STREET
• IMAGERY

BackgroundColor -> (string)

The background color and opacity values for a map.

Constraints:

• pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$

BaseMapVisibility -> (string)

The state of visibility for the base map.

Possible values:

• HIDDEN
• VISIBLE

Interactions -> (structure)

The general visual interactions setup for visual publish options

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

DataSetIdentifier -> (string) [required]

The dataset that is used to create the layer map visual. You can’t create a visual without a dataset.

Constraints:

• min: 1
• max: 2048

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

FunnelChartVisual -> (structure)

A funnel chart.

For more information, see Using funnel charts in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration of a FunnelChartVisual .

FieldWells -> (structure)

The field well configuration of a FunnelChartVisual .

FunnelChartAggregatedFieldWells -> (structure)

The field well configuration of a FunnelChartVisual .

Category -> (list)

The category field wells of a funnel chart. Values are grouped by category fields.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Values -> (list)

The value field wells of a funnel chart. Values are aggregated based on categories.

Constraints:

• max: 1

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

SortConfiguration -> (structure)

The sort configuration of a FunnelChartVisual .

CategorySort -> (list)

The sort configuration of the category fields.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

CategoryItemsLimit -> (structure)

The limit on the number of categories displayed.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

CategoryLabelOptions -> (structure)

The label options of the categories that are displayed in a FunnelChartVisual .

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ValueLabelOptions -> (structure)

The label options for the values that are displayed in a FunnelChartVisual .

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Tooltip -> (structure)

The tooltip configuration of a FunnelChartVisual .

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

DataLabelOptions -> (structure)

The options that determine the presentation of the data labels.

Visibility -> (string)

The visibility option that determines if data labels are displayed.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

The visibility of the category labels within the data labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

The visibility of the measure labels within the data labels.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the positioning of the data label relative to a section of the funnel.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelFontConfiguration -> (structure)

The font configuration for the data labels.

Only the FontSize attribute of the font configuration is used for data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

The color of the data label text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

MeasureDataLabelStyle -> (string)

Determines the style of the metric labels.

Possible values:

• VALUE_ONLY
• PERCENTAGE_BY_FIRST_STAGE
• PERCENTAGE_BY_PREVIOUS_STAGE
• VALUE_AND_PERCENTAGE_BY_FIRST_STAGE
• VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE

VisualPalette -> (structure)

The visual palette configuration of a FunnelChartVisual .

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

ScatterPlotVisual -> (structure)

A scatter plot.

For more information, see Using scatter plots in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

ScatterPlotCategoricallyAggregatedFieldWells -> (structure)

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

XAxis -> (list)

The x-axis field well of a scatter plot.

The x-axis is aggregated by category.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

YAxis -> (list)

The y-axis field well of a scatter plot.

The y-axis is aggregated by category.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Category -> (list)

The category field well of a scatter plot.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Size -> (list)

The size field well of a scatter plot.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Label -> (list)

The label field well of a scatter plot.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

ScatterPlotUnaggregatedFieldWells -> (structure)

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are unaggregated.

XAxis -> (list)

The x-axis field well of a scatter plot.

The x-axis is a dimension field and cannot be aggregated.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

YAxis -> (list)

The y-axis field well of a scatter plot.

The y-axis is a dimension field and cannot be aggregated.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Size -> (list)

The size field well of a scatter plot.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Category -> (list)

The category field well of a scatter plot.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

Label -> (list)

The label field well of a scatter plot.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

SortConfiguration -> (structure)

The sort configuration of a scatter plot.

ScatterPlotLimitConfiguration -> (structure)

The limit configuration of the visual display for an axis.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

XAxisLabelOptions -> (structure)

The label options (label text, label visibility, and sort icon visibility) of the scatter plot’s x-axis.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

XAxisDisplayOptions -> (structure)

The label display options (grid line, range, scale, and axis step) of the scatter plot’s x-axis.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

YAxisLabelOptions -> (structure)

The label options (label text, label visibility, and sort icon visibility) of the scatter plot’s y-axis.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

YAxisDisplayOptions -> (structure)

The label display options (grid line, range, scale, and axis step) of the scatter plot’s y-axis.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

DataLabels -> (structure)

The options that determine if visual data labels are displayed.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

Tooltip -> (structure)

The legend display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

VisualPalette -> (structure)

The palette (chart color) display setup of the visual.

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

ComboChartVisual -> (structure)

A combo chart.

For more information, see Using combo charts in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

ComboChartAggregatedFieldWells -> (structure)

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

Category -> (list)

The aggregated category field wells of a combo chart.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

BarValues -> (list)

The aggregated BarValues field well of a combo chart.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

Colors -> (list)

The aggregated colors field well of a combo chart.

Constraints:

• max: 200

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateDimensionField -> (structure)

The dimension type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DateGranularity -> (string)

The date granularity of the DateDimensionField . Choose one of the following options:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

LineValues -> (list)

The aggregated LineValues field well of a combo chart.

Constraints:

• max: 200

(structure)

The measure (metric) type field.

NumericalMeasureField -> (structure)

The measure type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (structure)

The aggregation function of the measure field.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalMeasureField -> (structure)

The measure type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

DateMeasureField -> (structure)

The measure type field with date type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the DateMeasureField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

AggregationFunction -> (string)

The aggregation function of the measure field.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

FormatConfiguration -> (structure)

The format configuration of the field.

DateTimeFormat -> (string)

Determines the DateTime format.

Constraints:

• min: 1
• max: 128

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric DateTime fields.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CalculatedMeasureField -> (structure)

The calculated measure field only used in pivot tables.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Expression -> (string) [required]

The expression in the table calculation.

Constraints:

• min: 1
• max: 4096

SortConfiguration -> (structure)

The sort configuration of a ComboChartVisual .

CategorySort -> (list)

The sort configuration of the category field well in a combo chart.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

CategoryItemsLimit -> (structure)

The item limit configuration for the category field well of a combo chart.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

ColorSort -> (list)

The sort configuration of the color field well in a combo chart.

Constraints:

• max: 100

(structure)

The field sort options in a chart configuration.

FieldSort -> (structure)

The sort configuration for a field in a field well.

FieldId -> (string) [required]

The sort configuration target field.

Constraints:

• min: 1
• max: 512

Direction -> (string) [required]

The sort direction. Choose one of the following options:

• ASC : Ascending
• DESC : Descending

Possible values:

• ASC
• DESC

ColumnSort -> (structure)

The sort configuration for a column that is not used in a field well.

SortBy -> (structure) [required]

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Direction -> (string) [required]

The sort direction.

Possible values:

• ASC
• DESC

AggregationFunction -> (structure)

The aggregation function that is defined in the column sort.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

ColorItemsLimit -> (structure)

The item limit configuration of the color field well in a combo chart.

ItemsLimit -> (long)

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

OtherCategories -> (string)

The Show other of an axis in the chart. Choose one of the following options:

• INCLUDE
• EXCLUDE

Possible values:

• INCLUDE
• EXCLUDE

BarsArrangement -> (string)

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

• CLUSTERED : For clustered bar combo charts.
• STACKED : For stacked bar combo charts.
• STACKED_PERCENT : Do not use. If you use this value, the operation returns a validation error.

Possible values:

• CLUSTERED
• STACKED
• STACKED_PERCENT

CategoryAxis -> (structure)

The category axis of a combo chart.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

CategoryLabelOptions -> (structure)

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

PrimaryYAxisDisplayOptions -> (structure)

The label display options (grid line, range, scale, and axis step) of a combo chart’s primary y-axis (bar) field well.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

PrimaryYAxisLabelOptions -> (structure)

The label options (label text, label visibility, and sort icon visibility) of a combo chart’s primary y-axis (bar) field well.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

SecondaryYAxisDisplayOptions -> (structure)

The label display options (grid line, range, scale, axis step) of a combo chart’s secondary y-axis (line) field well.

TickLabelOptions -> (structure)

The tick label options of an axis.

LabelOptions -> (structure)

Determines whether or not the axis ticks are visible.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

RotationAngle -> (double)

The rotation angle of the axis tick labels.

AxisLineVisibility -> (string)

Determines whether or not the axis line is visible.

Possible values:

• HIDDEN
• VISIBLE

GridLineVisibility -> (string)

Determines whether or not the grid line is visible.

Possible values:

• HIDDEN
• VISIBLE

DataOptions -> (structure)

The data options for an axis.

NumericAxisOptions -> (structure)

The options for an axis with a numeric field.

Scale -> (structure)

The scale setup of a numeric axis.

Linear -> (structure)

The linear axis scale setup.

StepCount -> (integer)

The step count setup of a linear axis.

StepSize -> (double)

The step size setup of a linear axis.

Logarithmic -> (structure)

The logarithmic axis scale setup.

Base -> (double)

The base setup of a logarithmic axis scale.

Range -> (structure)

The range setup of a numeric axis.

MinMax -> (structure)

The minimum and maximum setup of an axis display range.

Minimum -> (double)

The minimum setup for an axis display range.

Maximum -> (double)

The maximum setup for an axis display range.

DataDriven -> (structure)

The data-driven setup of an axis display range.

DateAxisOptions -> (structure)

The options for an axis with a date field.

MissingDateVisibility -> (string)

Determines whether or not missing dates are displayed.

Possible values:

• HIDDEN
• VISIBLE

ScrollbarOptions -> (structure)

The scroll bar options for an axis.

Visibility -> (string)

The visibility of the data zoom scroll bar.

Possible values:

• HIDDEN
• VISIBLE

VisibleRange -> (structure)

The visibility range for the data zoom scroll bar.

PercentRange -> (structure)

The percent range in the visible range.

From -> (double)

The lower bound of the range.

Constraints:

• min: 0
• max: 100

To -> (double)

The top bound of the range.

Constraints:

• min: 0
• max: 100

AxisOffset -> (string)

The offset value that determines the starting placement of the axis within a visual’s bounds.

SecondaryYAxisLabelOptions -> (structure)

The label options (label text, label visibility, and sort icon visibility) of a combo chart’s secondary y-axis(line) field well.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

SingleAxisOptions -> (structure)

The settings of a chart’s single axis configuration.

YAxisOptions -> (structure)

The Y axis options of a single axis configuration.

YAxis -> (string) [required]

The Y axis type to be used in the chart.

If you choose PRIMARY_Y_AXIS , the primary Y Axis is located on the leftmost vertical axis of the chart.

Possible values:

• PRIMARY_Y_AXIS

ColorLabelOptions -> (structure)

The label options (label text, label visibility, and sort icon visibility) of a combo chart’s color field well.

Visibility -> (string)

The visibility of an axis label on a chart. Choose one of the following options:

• VISIBLE : Shows the axis.
• HIDDEN : Hides the axis.

Possible values:

• HIDDEN
• VISIBLE

SortIconVisibility -> (string)

The visibility configuration of the sort icon on a chart’s axis label.

Possible values:

• HIDDEN
• VISIBLE

AxisLabelOptions -> (list)

The label options for a chart axis.

Constraints:

• max: 100

(structure)

The label options for a chart axis. You must specify the field that the label is targeted to.

FontConfiguration -> (structure)

The font configuration of the axis label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the axis label.

ApplyTo -> (structure)

The options that indicate which field the label belongs to.

FieldId -> (string) [required]

The field that the axis label is targeted to.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that the axis label is targeted to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Legend -> (structure)

The legend display setup of the visual.

Visibility -> (string)

Determines whether or not the legend is visible.

Possible values:

• HIDDEN
• VISIBLE

Title -> (structure)

The custom title for the legend.

Visibility -> (string)

Determines whether or not the label is visible.

Possible values:

• HIDDEN
• VISIBLE

FontConfiguration -> (structure)

The font configuration of the label.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

CustomLabel -> (string)

The text for the label.

Position -> (string)

The positions for the legend. Choose one of the following options:

• AUTO
• RIGHT
• BOTTOM
• LEFT

Possible values:

• AUTO
• RIGHT
• BOTTOM
• TOP

Width -> (string)

The width of the legend. If this value is omitted, a default width is used when rendering.

Height -> (string)

The height of the legend. If this value is omitted, a default height is used when rendering.

ValueFontConfiguration -> (structure)

Configures the display properties of the given text.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

BarDataLabels -> (structure)

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

LineDataLabels -> (structure)

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

Visibility -> (string)

Determines the visibility of the data labels.

Possible values:

• HIDDEN
• VISIBLE

CategoryLabelVisibility -> (string)

Determines the visibility of the category field labels.

Possible values:

• HIDDEN
• VISIBLE

MeasureLabelVisibility -> (string)

Determines the visibility of the measure field labels.

Possible values:

• HIDDEN
• VISIBLE

DataLabelTypes -> (list)

The option that determines the data label type.

Constraints:

• max: 100

(structure)

The option that determines the data label type.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldLabelType -> (structure)

Determines the label configuration for the entire field.

FieldId -> (string)

Indicates the field that is targeted by the field label.

Constraints:

• min: 1
• max: 512

Visibility -> (string)

The visibility of the field label.

Possible values:

• HIDDEN
• VISIBLE

DataPathLabelType -> (structure)

The option that specifies individual data values for labels.

FieldId -> (string)

The field ID of the field that the data label needs to be applied to.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that is labeled.

Constraints:

• max: 2048

Visibility -> (string)

The visibility of the data label.

Possible values:

• HIDDEN
• VISIBLE

RangeEndsLabelType -> (structure)

Determines the label configuration for range end value in a visual.

Visibility -> (string)

The visibility of the range ends label.

Possible values:

• HIDDEN
• VISIBLE

MinimumLabelType -> (structure)

Determines the label configuration for the minimum value in a visual.

Visibility -> (string)

The visibility of the minimum label.

Possible values:

• HIDDEN
• VISIBLE

MaximumLabelType -> (structure)

Determines the label configuration for the maximum value in a visual.

Visibility -> (string)

The visibility of the maximum label.

Possible values:

• HIDDEN
• VISIBLE

Position -> (string)

Determines the position of the data labels.

Possible values:

• INSIDE
• OUTSIDE
• LEFT
• TOP
• BOTTOM
• RIGHT

LabelContent -> (string)

Determines the content of the data labels.

Possible values:

• VALUE
• PERCENT
• VALUE_AND_PERCENT

LabelFontConfiguration -> (structure)

Determines the font configuration of the data labels.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

LabelColor -> (string)

Determines the color of the data labels.

Constraints:

• pattern: ^#[A-F0-9]{6}$

Overlap -> (string)

Determines whether overlap is enabled or disabled for the data labels.

Possible values:

• DISABLE_OVERLAP
• ENABLE_OVERLAP

TotalsVisibility -> (string)

Determines the visibility of the total.

Possible values:

• HIDDEN
• VISIBLE

Tooltip -> (structure)

The legend display setup of the visual.

TooltipVisibility -> (string)

Determines whether or not the tooltip is visible.

Possible values:

• HIDDEN
• VISIBLE

SelectedTooltipType -> (string)

The selected type for the tooltip. Choose one of the following options:

• BASIC : A basic tooltip.
• DETAILED : A detailed tooltip.

Possible values:

• BASIC
• DETAILED

FieldBasedTooltip -> (structure)

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

AggregationVisibility -> (string)

The visibility of Show aggregations .

Possible values:

• HIDDEN
• VISIBLE

TooltipTitleType -> (string)

The type for the >tooltip title. Choose one of the following options:

• NONE : Doesn’t use the primary value as the title.
• PRIMARY_VALUE : Uses primary value as the title.

Possible values:

• NONE
• PRIMARY_VALUE

TooltipFields -> (list)

The fields configuration in the tooltip.

Constraints:

• max: 100

(structure)

The tooltip.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FieldTooltipItem -> (structure)

The tooltip item for the fields.

FieldId -> (string) [required]

The unique ID of the field that is targeted by the tooltip.

Constraints:

• min: 1
• max: 512

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

TooltipTarget -> (string)

Determines the target of the field tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ColumnTooltipItem -> (structure)

The tooltip item for the columns that are not part of a field well.

Column -> (structure) [required]

The target column of the tooltip item.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Label -> (string)

The label of the tooltip item.

Visibility -> (string)

The visibility of the tooltip item.

Possible values:

• HIDDEN
• VISIBLE

Aggregation -> (structure)

The aggregation function of the column tooltip item.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

TooltipTarget -> (string)

Determines the target of the column tooltip item in a combo chart visual.

Possible values:

• BOTH
• BAR
• LINE

ReferenceLines -> (list)

The reference line setup of the visual.

Constraints:

• max: 20

(structure)

The reference line visual display options.

Status -> (string)

The status of the reference line. Choose one of the following options:

• ENABLE
• DISABLE

Possible values:

• ENABLED
• DISABLED

DataConfiguration -> (structure) [required]

The data configuration of the reference line.

StaticConfiguration -> (structure)

The static data configuration of the reference line data configuration.

Value -> (double) [required]

The double input of the static data.

DynamicConfiguration -> (structure)

The dynamic configuration of the reference line data configuration.

Column -> (structure) [required]

The column that the dynamic data targets.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

MeasureAggregationFunction -> (structure)

The aggregation function that is used in the dynamic data.

NumericalAggregationFunction -> (structure)

Aggregation for numerical values.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

CategoricalAggregationFunction -> (string)

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

Possible values:

• COUNT
• DISTINCT_COUNT

DateAggregationFunction -> (string)

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

Possible values:

• COUNT
• DISTINCT_COUNT
• MIN
• MAX

AttributeAggregationFunction -> (structure)

Aggregation for attributes.

SimpleAttributeAggregation -> (string)

The built-in aggregation functions for attributes.

• UNIQUE_VALUE : Returns the unique value for a field, aggregated by the dimension fields.

Possible values:

• UNIQUE_VALUE

ValueForMultipleValues -> (string)

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to ‘*’.

Calculation -> (structure) [required]

The calculation that is used in the dynamic data.

SimpleNumericalAggregation -> (string)

Built-in aggregation functions for numerical values.

• SUM : The sum of a dimension or measure.
• AVERAGE : The average of a dimension or measure.
• MIN : The minimum value of a dimension or measure.
• MAX : The maximum value of a dimension or measure.
• COUNT : The count of a dimension or measure.
• DISTINCT_COUNT : The count of distinct values in a dimension or measure.
• VAR : The variance of a dimension or measure.
• VARP : The partitioned variance of a dimension or measure.
• STDEV : The standard deviation of a dimension or measure.
• STDEVP : The partitioned standard deviation of a dimension or measure.
• MEDIAN : The median value of a dimension or measure.

Possible values:

• SUM
• AVERAGE
• MIN
• MAX
• COUNT
• DISTINCT_COUNT
• VAR
• VARP
• STDEV
• STDEVP
• MEDIAN

PercentileAggregation -> (structure)

An aggregation based on the percentile of values in a dimension or measure.

PercentileValue -> (double)

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

Constraints:

• min: 0
• max: 100

AxisBinding -> (string)

The axis binding type of the reference line. Choose one of the following options:

• PrimaryY
• SecondaryY

Possible values:

• PRIMARY_YAXIS
• SECONDARY_YAXIS

SeriesType -> (string)

The series type of the reference line data configuration. Choose one of the following options:

• BAR
• LINE

Possible values:

• BAR
• LINE

StyleConfiguration -> (structure)

The style configuration of the reference line.

Pattern -> (string)

The pattern type of the line style. Choose one of the following options:

• SOLID
• DASHED
• DOTTED

Possible values:

• SOLID
• DASHED
• DOTTED

Color -> (string)

The hex color of the reference line.

Constraints:

• pattern: ^#[A-F0-9]{6}$

LabelConfiguration -> (structure)

The label configuration of the reference line.

ValueLabelConfiguration -> (structure)

The value label configuration of the label in a reference line.

RelativePosition -> (string)

The relative position of the value label. Choose one of the following options:

• BEFORE_CUSTOM_LABEL
• AFTER_CUSTOM_LABEL

Possible values:

• BEFORE_CUSTOM_LABEL
• AFTER_CUSTOM_LABEL

FormatConfiguration -> (structure)

The format configuration of the value label.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CustomLabelConfiguration -> (structure)

The custom label configuration of the label in a reference line.

CustomLabel -> (string) [required]

The string text of the custom label.

Constraints:

• pattern: .*\S.*

FontConfiguration -> (structure)

The font configuration of the label in a reference line.

FontSize -> (structure)

The option that determines the text display size.

Relative -> (string)

The lexical name for the text size, proportional to its surrounding context.

Possible values:

• EXTRA_SMALL
• SMALL
• MEDIUM
• LARGE
• EXTRA_LARGE

Absolute -> (string)

The font size that you want to use in px.

FontDecoration -> (string)

Determines the appearance of decorative lines on the text.

Possible values:

• UNDERLINE
• NONE

FontColor -> (string)

Determines the color of the text.

Constraints:

• pattern: ^#[A-F0-9]{6}$

FontWeight -> (structure)

The option that determines the text display weight, or boldness.

Name -> (string)

The lexical name for the level of boldness of the text display.

Possible values:

• NORMAL
• BOLD

FontStyle -> (string)

Determines the text display face that is inherited by the given font family.

Possible values:

• NORMAL
• ITALIC

FontFamily -> (string)

The font family that you want to use.

FontColor -> (string)

The font color configuration of the label in a reference line.

Constraints:

• pattern: ^#[A-F0-9]{6}$

HorizontalPosition -> (string)

The horizontal position configuration of the label in a reference line. Choose one of the following options:

• LEFT
• CENTER
• RIGHT

Possible values:

• LEFT
• CENTER
• RIGHT

VerticalPosition -> (string)

The vertical position configuration of the label in a reference line. Choose one of the following options:

• ABOVE
• BELOW

Possible values:

• ABOVE
• BELOW

VisualPalette -> (structure)

The palette (chart color) display setup of the visual.

ChartColor -> (string)

The chart color options for the visual palette.

Constraints:

• pattern: ^#[A-F0-9]{6}$

ColorMap -> (list)

The color map options for the visual palette.

Constraints:

• max: 5000

(structure)

The color map that determines the color options for a particular element.

Element -> (structure) [required]

The element that the color needs to be applied to.

FieldId -> (string)

The field ID of the field that needs to be sorted.

Constraints:

• min: 1
• max: 512

FieldValue -> (string)

The actual value of the field that needs to be sorted.

Constraints:

• max: 2048

DataPathType -> (structure)

The type configuration of the field.

PivotTableDataPathType -> (string)

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY .
• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.
• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.
• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell .

Possible values:

• HIERARCHY_ROWS_LAYOUT_COLUMN
• MULTIPLE_ROW_METRICS_COLUMN
• EMPTY_COLUMN_HEADER
• COUNT_METRIC_COLUMN

Color -> (string) [required]

The color that needs to be applied to the element.

Constraints:

• pattern: ^#[A-F0-9]{6}$

TimeGranularity -> (string)

The time granularity of the field that the color needs to be applied to.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

Interactions -> (structure)

The general visual interactions setup for a visual.

VisualMenuOption -> (structure)

The on-visual menu options for a visual.

AvailabilityStatus -> (string)

The availaiblity status of a visual’s menu options.

Possible values:

• ENABLED
• DISABLED

ContextMenuOption -> (structure)

The context menu options for a visual.

AvailabilityStatus -> (string)

The availability status of the context menu options. If the value of this property is set to ENABLED , dashboard readers can interact with the context menu.

Possible values:

• ENABLED
• DISABLED

Actions -> (list)

The list of custom actions that are configured for a visual.

Constraints:

• max: 10

(structure)

A custom action defined on a visual.

CustomActionId -> (string) [required]

The ID of the VisualCustomAction .

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Name -> (string) [required]

The name of the VisualCustomAction .

Constraints:

• min: 1
• max: 256

Status -> (string)

The status of the VisualCustomAction .

Possible values:

• ENABLED
• DISABLED

Trigger -> (string) [required]

The trigger of the VisualCustomAction .

Valid values are defined as follows:

• DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a data point.
• DATA_POINT_MENU : Initiates a custom action by right pointer click from the menu.

Possible values:

• DATA_POINT_CLICK
• DATA_POINT_MENU

ActionOperations -> (list) [required]

A list of VisualCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

Constraints:

• min: 1
• max: 2

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

FilterOperation -> (structure)

The filter operation that filters data included in a visual or in an entire sheet.

SelectedFieldsConfiguration -> (structure) [required]

The configuration that chooses the fields to be filtered.

SelectedFields -> (list)

Chooses the fields that are filtered in CustomActionFilterOperation .

Constraints:

• min: 1
• max: 20

(string)

Constraints:

• min: 1
• max: 512

SelectedFieldOptions -> (string)

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation .

Valid values are defined as follows:

• ALL_FIELDS : Applies the filter operation to all fields.

Possible values:

• ALL_FIELDS

SelectedColumns -> (list)

The selected columns of a dataset.

Constraints:

• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

TargetVisualsConfiguration -> (structure) [required]

The configuration that chooses the target visuals to be filtered.

SameSheetTargetVisualConfiguration -> (structure)

The configuration of the same-sheet target visuals that you want to be filtered.

TargetVisuals -> (list)

A list of the target visual IDs that are located in the same sheet of the analysis.

Constraints:

• min: 1
• max: 50

(string)

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

TargetVisualOptions -> (string)

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

• ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.

Possible values:

• ALL_VISUALS

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string) [required]

The sheet that is targeted for navigation in the same analysis.

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string) [required]

THe URL link of the CustomActionURLOperation .

Constraints:

• min: 1
• max: 2048

URLTarget -> (string) [required]

The target of the CustomActionURLOperation .

Valid values are defined as follows:

• NEW_TAB : Opens the target URL in a new browser tab.
• NEW_WINDOW : Opens the target URL in a new browser window.
• SAME_TAB : Opens the target URL in the same browser tab.

Possible values:

• NEW_TAB
• NEW_WINDOW
• SAME_TAB

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list) [required]

The parameter that determines the value configuration.

Constraints:

• min: 1
• max: 200

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string) [required]

The destination parameter name of the SetParameterValueConfiguration .

Constraints:

• min: 1
• max: 2048
• pattern: ^[a-zA-Z0-9]+$

Value -> (structure) [required]

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure) [required]

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

Constraints:

• max: 50000

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

Constraints:

• max: 50000

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

Constraints:

• max: 50000

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

Constraints:

• max: 50000

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

Possible values:

• ALL_VALUES

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

Constraints:

• min: 1
• max: 512

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

ColumnHierarchies -> (list)

The column hierarchy that is used during drill-downs and drill-ups.

Constraints:

• max: 2

(structure)

The option that determines the hierarchy of the fields for a visual element.

ExplicitHierarchy -> (structure)

The option that determines the hierarchy of the fields that are built within a visual’s field wells. These fields can’t be duplicated to other visuals.

HierarchyId -> (string) [required]

The hierarchy ID of the explicit hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the explicit hierarchy.

Constraints:

• min: 2
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the explicit hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

DateTimeHierarchy -> (structure)

The option that determines the hierarchy of any DateTime fields.

HierarchyId -> (string) [required]

The hierarchy ID of the DateTime hierarchy.

Constraints:

• min: 1
• max: 512

DrillDownFilters -> (list)

The option that determines the drill down filters for the DateTime hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

PredefinedHierarchy -> (structure)

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

HierarchyId -> (string) [required]

The hierarchy ID of the predefined hierarchy.

Constraints:

• min: 1
• max: 512

Columns -> (list) [required]

The list of columns that define the predefined hierarchy.

Constraints:

• min: 1
• max: 10

(structure)

A column of a data set.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

DrillDownFilters -> (list)

The option that determines the drill down filters for the predefined hierarchy.

Constraints:

• max: 10

(structure)

The drill down filter for the column hierarchies.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NumericEqualityFilter -> (structure)

The numeric equality type drill down filter. This filter is used for number type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

Value -> (double) [required]

The value of the double input numeric drill down filter.

CategoryFilter -> (structure)

The category type drill down filter. This filter is used for string type columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

CategoryValues -> (list) [required]

A list of the string inputs that are the values of the category drill down filter.

Constraints:

• max: 100000

(string)

Constraints:

• max: 512

TimeRangeFilter -> (structure)

The time range drill down filter. This filter is used for date time columns.

Column -> (structure) [required]

The column that the filter is applied to.

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

RangeMinimum -> (timestamp) [required]

The minimum value for the filter value range.

RangeMaximum -> (timestamp) [required]

The maximum value for the filter value range.

TimeGranularity -> (string) [required]

The level of time precision that is used to aggregate DateTime values.

Possible values:

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

VisualContentAltText -> (string)

The alt text for the visual.

Constraints:

• min: 1
• max: 1024

BoxPlotVisual -> (structure)

A box plot.

For more information, see Using box plots in the Amazon Quick Suite User Guide .

VisualId -> (string) [required]

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

Constraints:

• min: 1
• max: 512
• pattern: [\w\-]+

Title -> (structure)

The title that is displayed on the visual.

Visibility -> (string)

The visibility of the title label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The short text format of the title label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 512

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 1024

Subtitle -> (structure)

The subtitle that is displayed on the visual.

Visibility -> (string)

The visibility of the subtitle label.

Possible values:

• HIDDEN
• VISIBLE

FormatText -> (structure)

The long text format of the subtitle label, such as plain text or rich text.

PlainText -> (string)

Plain text format.

Constraints:

• min: 1
• max: 1024

RichText -> (string)

Rich text. Examples of rich text include bold, underline, and italics.

Constraints:

• min: 1
• max: 2048

ChartConfiguration -> (structure)

The configuration settings of the visual.

FieldWells -> (structure)

The field wells of the visual.

BoxPlotAggregatedFieldWells -> (structure)

The aggregated field wells of a box plot.

GroupBy -> (list)

The group by field well of a box plot chart. Values are grouped based on group by fields.

Constraints:

• max: 1

(structure)

The dimension type field.

NumericalDimensionField -> (structure)

The dimension type field with numerical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the NumericalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

FormatConfiguration -> (structure)

The options that determine the numeric format configuration.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CategoricalDimensionField -> (structure)

The dimension type field with categorical type columns.

FieldId -> (string) [required]

The custom field ID.

Constraints:

• min: 1
• max: 512

Column -> (structure) [required]

The column that is used in the CategoricalDimensionField .

DataSetIdentifier -> (string) [required]

The data set that the column belongs to.

Constraints:

• min: 1
• max: 2048

ColumnName -> (string) [required]

The name of the column.

Constraints:

• min: 1
• max: 128

HierarchyId -> (string)

The custom hierarchy ID.

Constraints:

• min: 1
• max: 512

FormatConfiguration -> (structure)

The format configuration of the field.

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

NumericFormatConfiguration -> (structure)

The formatting configuration for numeric strings.

NumberDisplayFormatConfiguration -> (structure)

The options that determine the number display format configuration.

Prefix -> (string)

Determines the prefix value of the number format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the number format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value of the number format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

CurrencyDisplayFormatConfiguration -> (structure)

The options that determine the currency display format configuration.

Prefix -> (string)

Determines the prefix value of the currency format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the currency format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT
• SPACE

ThousandsSeparator -> (structure)

The options that determine the thousands separator configuration.

Symbol -> (string)

Determines the thousands separator symbol.

Possible values:

• COMMA
• DOT
• SPACE

Visibility -> (string)

Determines the visibility of the thousands separator.

Possible values:

• HIDDEN
• VISIBLE

GroupingStyle -> (string)

Determines the way numbers are styled to accommodate different readability standards. The DEFAULT value uses the standard international grouping system and groups numbers by the thousands. The LAKHS value uses the Indian numbering system and groups numbers by lakhs and crores.

Possible values:

• DEFAULT
• LAKHS

Symbol -> (string)

Determines the symbol for the currency format.

Constraints:

• pattern: [A-Z]{3}

DecimalPlacesConfiguration -> (structure)

The option that determines the decimal places configuration.

DecimalPlaces -> (long) [required]

The values of the decimal places.

Constraints:

• min: 0
• max: 20

NumberScale -> (string)

Determines the number scale value for the currency format.

Possible values:

• NONE
• AUTO
• THOUSANDS
• MILLIONS
• BILLIONS
• TRILLIONS
• LAKHS
• CRORES

NegativeValueConfiguration -> (structure)

The options that determine the negative value configuration.

DisplayMode -> (string) [required]

Determines the display mode of the negative value configuration.

Possible values:

• POSITIVE
• NEGATIVE

NullValueFormatConfiguration -> (structure)

The options that determine the null value format configuration.

NullString -> (string) [required]

Determines the null string of null values.

Constraints:

• min: 1
• max: 128

PercentageDisplayFormatConfiguration -> (structure)

The options that determine the percentage display format configuration.

Prefix -> (string)

Determines the prefix value of the percentage format.

Constraints:

• min: 1
• max: 128

Suffix -> (string)

Determines the suffix value of the percentage format.

Constraints:

• min: 1
• max: 128

SeparatorConfiguration -> (structure)

The options that determine the numeric separator configuration.

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

• COMMA
• DOT