Amazon QuickSight 2018-04-01
- Client: Aws\QuickSight\QuickSightClient
- Service ID: quicksight
- Version: 2018-04-01
This page describes the parameters and results for the operations of the Amazon QuickSight (2018-04-01), and shows how to use the Aws\QuickSight\QuickSightClient object to call the described operations. This documentation is specific to the 2018-04-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- BatchCreateTopicReviewedAnswer ( array $params = [] )
- Creates new reviewed answers for a Q Topic.
- BatchDeleteTopicReviewedAnswer ( array $params = [] )
- Deletes reviewed answers for Q Topic.
- CancelIngestion ( array $params = [] )
- Cancels an ongoing ingestion of data into SPICE.
- CreateAccountCustomization ( array $params = [] )
- Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
- CreateAccountSubscription ( array $params = [] )
- Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
- CreateAnalysis ( array $params = [] )
- Creates an analysis in Amazon QuickSight.
- CreateBrand ( array $params = [] )
- Creates an Amazon QuickSight brand.
- CreateCustomPermissions ( array $params = [] )
- Creates a custom permissions profile.
- CreateDashboard ( array $params = [] )
- Creates a dashboard from either a template or directly with a DashboardDefinition.
- CreateDataSet ( array $params = [] )
- Creates a dataset.
- CreateDataSource ( array $params = [] )
- Creates a data source.
- CreateFolder ( array $params = [] )
- Creates an empty shared folder.
- CreateFolderMembership ( array $params = [] )
- Adds an asset, such as a dashboard, analysis, or dataset into a folder.
- CreateGroup ( array $params = [] )
- Use the CreateGroup operation to create a group in Amazon QuickSight.
- CreateGroupMembership ( array $params = [] )
- Adds an Amazon QuickSight user to an Amazon QuickSight group.
- CreateIAMPolicyAssignment ( array $params = [] )
- Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
- CreateIngestion ( array $params = [] )
- Creates and starts a new SPICE ingestion for a dataset.
- CreateNamespace ( array $params = [] )
- (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
- CreateRefreshSchedule ( array $params = [] )
- Creates a refresh schedule for a dataset.
- CreateRoleMembership ( array $params = [] )
- Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
- CreateTemplate ( array $params = [] )
- Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template.
- CreateTemplateAlias ( array $params = [] )
- Creates a template alias for a template.
- CreateTheme ( array $params = [] )
- Creates a theme.
- CreateThemeAlias ( array $params = [] )
- Creates a theme alias for a theme.
- CreateTopic ( array $params = [] )
- Creates a new Q topic.
- CreateTopicRefreshSchedule ( array $params = [] )
- Creates a topic refresh schedule.
- CreateVPCConnection ( array $params = [] )
- Creates a new VPC connection.
- DeleteAccountCustomization ( array $params = [] )
- Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
- DeleteAccountSubscription ( array $params = [] )
- Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account.
- DeleteAnalysis ( array $params = [] )
- Deletes an analysis from Amazon QuickSight.
- DeleteBrand ( array $params = [] )
- Deletes an Amazon QuickSight brand.
- DeleteBrandAssignment ( array $params = [] )
- Deletes a brand assignment.
- DeleteCustomPermissions ( array $params = [] )
- Deletes a custom permissions profile.
- DeleteDashboard ( array $params = [] )
- Deletes a dashboard.
- DeleteDataSet ( array $params = [] )
- Deletes a dataset.
- DeleteDataSetRefreshProperties ( array $params = [] )
- Deletes the dataset refresh properties of the dataset.
- DeleteDataSource ( array $params = [] )
- Deletes the data source permanently.
- DeleteDefaultQBusinessApplication ( array $params = [] )
- Deletes a linked Amazon Q Business application from an Amazon QuickSight account
- DeleteFolder ( array $params = [] )
- Deletes an empty folder.
- DeleteFolderMembership ( array $params = [] )
- Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
- DeleteGroup ( array $params = [] )
- Removes a user group from Amazon QuickSight.
- DeleteGroupMembership ( array $params = [] )
- Removes a user from a group so that the user is no longer a member of the group.
- DeleteIAMPolicyAssignment ( array $params = [] )
- Deletes an existing IAM policy assignment.
- DeleteIdentityPropagationConfig ( array $params = [] )
- Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
- DeleteNamespace ( array $params = [] )
- Deletes a namespace and the users and groups that are associated with the namespace.
- DeleteRefreshSchedule ( array $params = [] )
- Deletes a refresh schedule from a dataset.
- DeleteRoleCustomPermission ( array $params = [] )
- Removes custom permissions from the role.
- DeleteRoleMembership ( array $params = [] )
- Removes a group from a role.
- DeleteTemplate ( array $params = [] )
- Deletes a template.
- DeleteTemplateAlias ( array $params = [] )
- Deletes the item that the specified template alias points to.
- DeleteTheme ( array $params = [] )
- Deletes a theme.
- DeleteThemeAlias ( array $params = [] )
- Deletes the version of the theme that the specified theme alias points to.
- DeleteTopic ( array $params = [] )
- Deletes a topic.
- DeleteTopicRefreshSchedule ( array $params = [] )
- Deletes a topic refresh schedule.
- DeleteUser ( array $params = [] )
- Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
- DeleteUserByPrincipalId ( array $params = [] )
- Deletes a user identified by its principal ID.
- DeleteUserCustomPermission ( array $params = [] )
- Deletes a custom permissions profile from a user.
- DeleteVPCConnection ( array $params = [] )
- Deletes a VPC connection.
- DescribeAccountCustomization ( array $params = [] )
- Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
- DescribeAccountSettings ( array $params = [] )
- Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
- DescribeAccountSubscription ( array $params = [] )
- Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
- DescribeAnalysis ( array $params = [] )
- Provides a summary of the metadata for an analysis.
- DescribeAnalysisDefinition ( array $params = [] )
- Provides a detailed description of the definition of an analysis.
- DescribeAnalysisPermissions ( array $params = [] )
- Provides the read and write permissions for an analysis.
- DescribeAssetBundleExportJob ( array $params = [] )
- Describes an existing export job.
- DescribeAssetBundleImportJob ( array $params = [] )
- Describes an existing import job.
- DescribeBrand ( array $params = [] )
- Describes a brand.
- DescribeBrandAssignment ( array $params = [] )
- Describes a brand assignment.
- DescribeBrandPublishedVersion ( array $params = [] )
- Describes the published version of the brand.
- DescribeCustomPermissions ( array $params = [] )
- Describes a custom permissions profile.
- DescribeDashboard ( array $params = [] )
- Provides a summary for a dashboard.
- DescribeDashboardDefinition ( array $params = [] )
- Provides a detailed description of the definition of a dashboard.
- DescribeDashboardPermissions ( array $params = [] )
- Describes read and write permissions for a dashboard.
- DescribeDashboardSnapshotJob ( array $params = [] )
- Describes an existing snapshot job.
- DescribeDashboardSnapshotJobResult ( array $params = [] )
- Describes the result of an existing snapshot job that has finished running.
- DescribeDashboardsQAConfiguration ( array $params = [] )
- Describes an existing dashboard QA configuration.
- DescribeDataSet ( array $params = [] )
- Describes a dataset.
- DescribeDataSetPermissions ( array $params = [] )
- Describes the permissions on a dataset.
- DescribeDataSetRefreshProperties ( array $params = [] )
- Describes the refresh properties of a dataset.
- DescribeDataSource ( array $params = [] )
- Describes a data source.
- DescribeDataSourcePermissions ( array $params = [] )
- Describes the resource permissions for a data source.
- DescribeDefaultQBusinessApplication ( array $params = [] )
- Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.
- DescribeFolder ( array $params = [] )
- Describes a folder.
- DescribeFolderPermissions ( array $params = [] )
- Describes permissions for a folder.
- DescribeFolderResolvedPermissions ( array $params = [] )
- Describes the folder resolved permissions.
- DescribeGroup ( array $params = [] )
- Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
- DescribeGroupMembership ( array $params = [] )
- Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.
- DescribeIAMPolicyAssignment ( array $params = [] )
- Describes an existing IAM policy assignment, as specified by the assignment name.
- DescribeIngestion ( array $params = [] )
- Describes a SPICE ingestion.
- DescribeIpRestriction ( array $params = [] )
- Provides a summary and status of IP rules.
- DescribeKeyRegistration ( array $params = [] )
- Describes all customer managed key registrations in a Amazon QuickSight account.
- DescribeNamespace ( array $params = [] )
- Describes the current namespace.
- DescribeQPersonalizationConfiguration ( array $params = [] )
- Describes a personalization configuration.
- DescribeQuickSightQSearchConfiguration ( array $params = [] )
- Describes the state of a Amazon QuickSight Q Search configuration.
- DescribeRefreshSchedule ( array $params = [] )
- Provides a summary of a refresh schedule.
- DescribeRoleCustomPermission ( array $params = [] )
- Describes all custom permissions that are mapped to a role.
- DescribeTemplate ( array $params = [] )
- Describes a template's metadata.
- DescribeTemplateAlias ( array $params = [] )
- Describes the template alias for a template.
- DescribeTemplateDefinition ( array $params = [] )
- Provides a detailed description of the definition of a template.
- DescribeTemplatePermissions ( array $params = [] )
- Describes read and write permissions on a template.
- DescribeTheme ( array $params = [] )
- Describes a theme.
- DescribeThemeAlias ( array $params = [] )
- Describes the alias for a theme.
- DescribeThemePermissions ( array $params = [] )
- Describes the read and write permissions for a theme.
- DescribeTopic ( array $params = [] )
- Describes a topic.
- DescribeTopicPermissions ( array $params = [] )
- Describes the permissions of a topic.
- DescribeTopicRefresh ( array $params = [] )
- Describes the status of a topic refresh.
- DescribeTopicRefreshSchedule ( array $params = [] )
- Deletes a topic refresh schedule.
- DescribeUser ( array $params = [] )
- Returns information about a user, given the user name.
- DescribeVPCConnection ( array $params = [] )
- Describes a VPC connection.
- GenerateEmbedUrlForAnonymousUser ( array $params = [] )
- Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.
- GenerateEmbedUrlForRegisteredUser ( array $params = [] )
- Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
- GenerateEmbedUrlForRegisteredUserWithIdentity ( array $params = [] )
- Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
- GetDashboardEmbedUrl ( array $params = [] )
- Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application.
- GetSessionEmbedUrl ( array $params = [] )
- Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.
- ListAnalyses ( array $params = [] )
- Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
- ListAssetBundleExportJobs ( array $params = [] )
- Lists all asset bundle export jobs that have been taken place in the last 14 days.
- ListAssetBundleImportJobs ( array $params = [] )
- Lists all asset bundle import jobs that have taken place in the last 14 days.
- ListBrands ( array $params = [] )
- Lists all brands in an Amazon QuickSight account.
- ListCustomPermissions ( array $params = [] )
- Returns a list of all the custom permissions profiles.
- ListDashboardVersions ( array $params = [] )
- Lists all the versions of the dashboards in the Amazon QuickSight subscription.
- ListDashboards ( array $params = [] )
- Lists dashboards in an Amazon Web Services account.
- ListDataSets ( array $params = [] )
- Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
- ListDataSources ( array $params = [] )
- Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
- ListFolderMembers ( array $params = [] )
- List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
- ListFolders ( array $params = [] )
- Lists all folders in an account.
- ListFoldersForResource ( array $params = [] )
- List all folders that a resource is a member of.
- ListGroupMemberships ( array $params = [] )
- Lists member users in a group.
- ListGroups ( array $params = [] )
- Lists all user groups in Amazon QuickSight.
- ListIAMPolicyAssignments ( array $params = [] )
- Lists the IAM policy assignments in the current Amazon QuickSight account.
- ListIAMPolicyAssignmentsForUser ( array $params = [] )
- Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
- ListIdentityPropagationConfigs ( array $params = [] )
- Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
- ListIngestions ( array $params = [] )
- Lists the history of SPICE ingestions for a dataset.
- ListNamespaces ( array $params = [] )
- Lists the namespaces for the specified Amazon Web Services account.
- ListRefreshSchedules ( array $params = [] )
- Lists the refresh schedules of a dataset.
- ListRoleMemberships ( array $params = [] )
- Lists all groups that are associated with a role.
- ListTagsForResource ( array $params = [] )
- Lists the tags assigned to a resource.
- ListTemplateAliases ( array $params = [] )
- Lists all the aliases of a template.
- ListTemplateVersions ( array $params = [] )
- Lists all the versions of the templates in the current Amazon QuickSight account.
- ListTemplates ( array $params = [] )
- Lists all the templates in the current Amazon QuickSight account.
- ListThemeAliases ( array $params = [] )
- Lists all the aliases of a theme.
- ListThemeVersions ( array $params = [] )
- Lists all the versions of the themes in the current Amazon Web Services account.
- ListThemes ( array $params = [] )
- Lists all the themes in the current Amazon Web Services account.
- ListTopicRefreshSchedules ( array $params = [] )
- Lists all of the refresh schedules for a topic.
- ListTopicReviewedAnswers ( array $params = [] )
- Lists all reviewed answers for a Q Topic.
- ListTopics ( array $params = [] )
- Lists all of the topics within an account.
- ListUserGroups ( array $params = [] )
- Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
- ListUsers ( array $params = [] )
- Returns a list of all of the Amazon QuickSight users belonging to this account.
- ListVPCConnections ( array $params = [] )
- Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
- PredictQAResults ( array $params = [] )
- Predicts existing visuals or generates new visuals to answer a given query.
- PutDataSetRefreshProperties ( array $params = [] )
- Creates or updates the dataset refresh properties for the dataset.
- RegisterUser ( array $params = [] )
- Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
- RestoreAnalysis ( array $params = [] )
- Restores an analysis.
- SearchAnalyses ( array $params = [] )
- Searches for analyses that belong to the user specified in the filter.
- SearchDashboards ( array $params = [] )
- Searches for dashboards that belong to a user.
- SearchDataSets ( array $params = [] )
- Use the SearchDataSets operation to search for datasets that belong to an account.
- SearchDataSources ( array $params = [] )
- Use the SearchDataSources operation to search for data sources that belong to an account.
- SearchFolders ( array $params = [] )
- Searches the subfolders in a folder.
- SearchGroups ( array $params = [] )
- Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
- SearchTopics ( array $params = [] )
- Searches for any Q topic that exists in an Amazon QuickSight account.
- StartAssetBundleExportJob ( array $params = [] )
- Starts an Asset Bundle export job.
- StartAssetBundleImportJob ( array $params = [] )
- Starts an Asset Bundle import job.
- StartDashboardSnapshotJob ( array $params = [] )
- Starts an asynchronous job that generates a snapshot of a dashboard's output.
- StartDashboardSnapshotJobSchedule ( array $params = [] )
- Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
- TagResource ( array $params = [] )
- Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
- UntagResource ( array $params = [] )
- Removes a tag or tags from a resource.
- UpdateAccountCustomization ( array $params = [] )
- Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
- UpdateAccountSettings ( array $params = [] )
- Updates the Amazon QuickSight settings in your Amazon Web Services account.
- UpdateAnalysis ( array $params = [] )
- Updates an analysis in Amazon QuickSight
- UpdateAnalysisPermissions ( array $params = [] )
- Updates the read and write permissions for an analysis.
- UpdateApplicationWithTokenExchangeGrant ( array $params = [] )
- Updates an Amazon QuickSight application with a token exchange grant.
- UpdateBrand ( array $params = [] )
- Updates a brand.
- UpdateBrandAssignment ( array $params = [] )
- Updates a brand assignment.
- UpdateBrandPublishedVersion ( array $params = [] )
- Updates the published version of a brand.
- UpdateCustomPermissions ( array $params = [] )
- Updates a custom permissions profile.
- UpdateDashboard ( array $params = [] )
- Updates a dashboard in an Amazon Web Services account.
- UpdateDashboardLinks ( array $params = [] )
- Updates the linked analyses on a dashboard.
- UpdateDashboardPermissions ( array $params = [] )
- Updates read and write permissions on a dashboard.
- UpdateDashboardPublishedVersion ( array $params = [] )
- Updates the published version of a dashboard.
- UpdateDashboardsQAConfiguration ( array $params = [] )
- Updates a Dashboard QA configuration.
- UpdateDataSet ( array $params = [] )
- Updates a dataset.
- UpdateDataSetPermissions ( array $params = [] )
- Updates the permissions on a dataset.
- UpdateDataSource ( array $params = [] )
- Updates a data source.
- UpdateDataSourcePermissions ( array $params = [] )
- Updates the permissions to a data source.
- UpdateDefaultQBusinessApplication ( array $params = [] )
- Updates a Amazon Q Business application that is linked to a Amazon QuickSight account.
- UpdateFolder ( array $params = [] )
- Updates the name of a folder.
- UpdateFolderPermissions ( array $params = [] )
- Updates permissions of a folder.
- UpdateGroup ( array $params = [] )
- Changes a group description.
- UpdateIAMPolicyAssignment ( array $params = [] )
- Updates an existing IAM policy assignment.
- UpdateIdentityPropagationConfig ( array $params = [] )
- Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
- UpdateIpRestriction ( array $params = [] )
- Updates the content and status of IP rules.
- UpdateKeyRegistration ( array $params = [] )
- Updates a customer managed key in a Amazon QuickSight account.
- UpdatePublicSharingSettings ( array $params = [] )
- Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.
- UpdateQPersonalizationConfiguration ( array $params = [] )
- Updates a personalization configuration.
- UpdateQuickSightQSearchConfiguration ( array $params = [] )
- Updates the state of a Amazon QuickSight Q Search configuration.
- UpdateRefreshSchedule ( array $params = [] )
- Updates a refresh schedule for a dataset.
- UpdateRoleCustomPermission ( array $params = [] )
- Updates the custom permissions that are associated with a role.
- UpdateSPICECapacityConfiguration ( array $params = [] )
- Updates the SPICE capacity configuration for a Amazon QuickSight account.
- UpdateTemplate ( array $params = [] )
- Updates a template from an existing Amazon QuickSight analysis or another template.
- UpdateTemplateAlias ( array $params = [] )
- Updates the template alias of a template.
- UpdateTemplatePermissions ( array $params = [] )
- Updates the resource permissions for a template.
- UpdateTheme ( array $params = [] )
- Updates a theme.
- UpdateThemeAlias ( array $params = [] )
- Updates an alias of a theme.
- UpdateThemePermissions ( array $params = [] )
- Updates the resource permissions for a theme.
- UpdateTopic ( array $params = [] )
- Updates a topic.
- UpdateTopicPermissions ( array $params = [] )
- Updates the permissions of a topic.
- UpdateTopicRefreshSchedule ( array $params = [] )
- Updates a topic refresh schedule.
- UpdateUser ( array $params = [] )
- Updates an Amazon QuickSight user.
- UpdateUserCustomPermission ( array $params = [] )
- Updates a custom permissions profile for a user.
- UpdateVPCConnection ( array $params = [] )
- Updates a VPC connection.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeFolderPermissions
- DescribeFolderResolvedPermissions
- ListAnalyses
- ListAssetBundleExportJobs
- ListAssetBundleImportJobs
- ListBrands
- ListCustomPermissions
- ListDashboardVersions
- ListDashboards
- ListDataSets
- ListDataSources
- ListFolderMembers
- ListFolders
- ListFoldersForResource
- ListGroupMemberships
- ListGroups
- ListIAMPolicyAssignments
- ListIAMPolicyAssignmentsForUser
- ListIngestions
- ListNamespaces
- ListRoleMemberships
- ListTemplateAliases
- ListTemplateVersions
- ListTemplates
- ListThemeVersions
- ListThemes
- ListTopics
- ListUserGroups
- ListUsers
- ListVPCConnections
- SearchAnalyses
- SearchDashboards
- SearchDataSets
- SearchDataSources
- SearchFolders
- SearchGroups
- SearchTopics
Operations
BatchCreateTopicReviewedAnswer
$result = $client->batchCreateTopicReviewedAnswer
([/* ... */]); $promise = $client->batchCreateTopicReviewedAnswerAsync
([/* ... */]);
Creates new reviewed answers for a Q Topic.
Parameter Syntax
$result = $client->batchCreateTopicReviewedAnswer([ 'Answers' => [ // REQUIRED [ 'AnswerId' => '<string>', // REQUIRED 'DatasetArn' => '<string>', // REQUIRED 'Mir' => [ 'ContributionAnalysis' => [ 'Direction' => 'INCREASE|DECREASE|NEUTRAL', 'Factors' => [ [ 'FieldName' => '<string>', ], // ... ], 'SortType' => 'ABSOLUTE_DIFFERENCE|CONTRIBUTION_PERCENTAGE|DEVIATION_FROM_EXPECTED|PERCENTAGE_DIFFERENCE', 'TimeRanges' => [ 'EndRange' => [ 'AggMetrics' => [ [ 'Function' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'MetricOperand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], // ... ], 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'AggregationPartitionBy' => [ [ 'FieldName' => '<string>', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], 'Anchor' => [ 'AnchorType' => 'TODAY', 'Offset' => <integer>, 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], 'Constant' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'FilterClass' => 'ENFORCED_VALUE_FILTER|CONDITIONAL_VALUE_FILTER|NAMED_VALUE_FILTER', 'FilterType' => 'CATEGORY_FILTER|NUMERIC_EQUALITY_FILTER|NUMERIC_RANGE_FILTER|DATE_RANGE_FILTER|RELATIVE_DATE_FILTER|TOP_BOTTOM_FILTER|EQUALS|RANK_LIMIT_FILTER|ACCEPT_ALL_FILTER', 'Function' => 'CONTAINS|EXACT|STARTS_WITH|ENDS_WITH|CONTAINS_STRING|PREVIOUS|THIS|LAST|NEXT|NOW', 'Inclusive' => true || false, 'Inverse' => true || false, 'LastNextOffset' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'NullFilter' => 'ALL_VALUES|NON_NULLS_ONLY|NULLS_ONLY', 'OperandField' => [ 'Identity' => '<string>', // REQUIRED ], 'Range' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'SortDirection' => 'ASCENDING|DESCENDING', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'TopBottomLimit' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], ], 'StartRange' => [ 'AggMetrics' => [ [ 'Function' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'MetricOperand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], // ... ], 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'AggregationPartitionBy' => [ [ 'FieldName' => '<string>', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], 'Anchor' => [ 'AnchorType' => 'TODAY', 'Offset' => <integer>, 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], 'Constant' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'FilterClass' => 'ENFORCED_VALUE_FILTER|CONDITIONAL_VALUE_FILTER|NAMED_VALUE_FILTER', 'FilterType' => 'CATEGORY_FILTER|NUMERIC_EQUALITY_FILTER|NUMERIC_RANGE_FILTER|DATE_RANGE_FILTER|RELATIVE_DATE_FILTER|TOP_BOTTOM_FILTER|EQUALS|RANK_LIMIT_FILTER|ACCEPT_ALL_FILTER', 'Function' => 'CONTAINS|EXACT|STARTS_WITH|ENDS_WITH|CONTAINS_STRING|PREVIOUS|THIS|LAST|NEXT|NOW', 'Inclusive' => true || false, 'Inverse' => true || false, 'LastNextOffset' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'NullFilter' => 'ALL_VALUES|NON_NULLS_ONLY|NULLS_ONLY', 'OperandField' => [ 'Identity' => '<string>', // REQUIRED ], 'Range' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'SortDirection' => 'ASCENDING|DESCENDING', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'TopBottomLimit' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], ], ], ], 'Filters' => [ [ [ 'AggMetrics' => [ [ 'Function' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'MetricOperand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], // ... ], 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'AggregationPartitionBy' => [ [ 'FieldName' => '<string>', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], 'Anchor' => [ 'AnchorType' => 'TODAY', 'Offset' => <integer>, 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], 'Constant' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'FilterClass' => 'ENFORCED_VALUE_FILTER|CONDITIONAL_VALUE_FILTER|NAMED_VALUE_FILTER', 'FilterType' => 'CATEGORY_FILTER|NUMERIC_EQUALITY_FILTER|NUMERIC_RANGE_FILTER|DATE_RANGE_FILTER|RELATIVE_DATE_FILTER|TOP_BOTTOM_FILTER|EQUALS|RANK_LIMIT_FILTER|ACCEPT_ALL_FILTER', 'Function' => 'CONTAINS|EXACT|STARTS_WITH|ENDS_WITH|CONTAINS_STRING|PREVIOUS|THIS|LAST|NEXT|NOW', 'Inclusive' => true || false, 'Inverse' => true || false, 'LastNextOffset' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'NullFilter' => 'ALL_VALUES|NON_NULLS_ONLY|NULLS_ONLY', 'OperandField' => [ 'Identity' => '<string>', // REQUIRED ], 'Range' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'SortDirection' => 'ASCENDING|DESCENDING', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'TopBottomLimit' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], ], // ... ], // ... ], 'GroupByList' => [ [ 'DisplayFormat' => 'AUTO|PERCENT|CURRENCY|NUMBER|DATE|STRING', 'DisplayFormatOptions' => [ 'BlankCellFormat' => '<string>', 'CurrencySymbol' => '<string>', 'DateFormat' => '<string>', 'DecimalSeparator' => 'COMMA|DOT', 'FractionDigits' => <integer>, 'GroupingSeparator' => '<string>', 'NegativeFormat' => [ 'Prefix' => '<string>', 'Suffix' => '<string>', ], 'Prefix' => '<string>', 'Suffix' => '<string>', 'UnitScaler' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'UseBlankCellFormat' => true || false, 'UseGrouping' => true || false, ], 'FieldName' => [ 'Identity' => '<string>', // REQUIRED ], 'NamedEntity' => [ 'NamedEntityName' => '<string>', ], 'Sort' => [ 'Operand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], 'TimeGranularity' => 'SECOND|MINUTE|HOUR|DAY|WEEK|MONTH|QUARTER|YEAR', ], // ... ], 'Metrics' => [ [ 'CalculatedFieldReferences' => [ [ 'Identity' => '<string>', // REQUIRED ], // ... ], 'ComparisonMethod' => [ 'Period' => 'SECOND|MINUTE|HOUR|DAY|WEEK|MONTH|QUARTER|YEAR', 'Type' => 'DIFF|PERC_DIFF|DIFF_AS_PERC|POP_CURRENT_DIFF_AS_PERC|POP_CURRENT_DIFF|POP_OVERTIME_DIFF_AS_PERC|POP_OVERTIME_DIFF|PERCENT_OF_TOTAL|RUNNING_SUM|MOVING_AVERAGE', 'WindowSize' => <integer>, ], 'DisplayFormat' => 'AUTO|PERCENT|CURRENCY|NUMBER|DATE|STRING', 'DisplayFormatOptions' => [ 'BlankCellFormat' => '<string>', 'CurrencySymbol' => '<string>', 'DateFormat' => '<string>', 'DecimalSeparator' => 'COMMA|DOT', 'FractionDigits' => <integer>, 'GroupingSeparator' => '<string>', 'NegativeFormat' => [ 'Prefix' => '<string>', 'Suffix' => '<string>', ], 'Prefix' => '<string>', 'Suffix' => '<string>', 'UnitScaler' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'UseBlankCellFormat' => true || false, 'UseGrouping' => true || false, ], 'Expression' => '<string>', 'Function' => [ 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'Period' => 'SECOND|MINUTE|HOUR|DAY|WEEK|MONTH|QUARTER|YEAR', 'PeriodField' => '<string>', ], 'MetricId' => [ 'Identity' => '<string>', // REQUIRED ], 'NamedEntity' => [ 'NamedEntityName' => '<string>', ], 'Operands' => [ [ 'Identity' => '<string>', // REQUIRED ], // ... ], ], // ... ], 'Sort' => [ 'Operand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], 'Visual' => [ 'type' => '<string>', ], ], 'PrimaryVisual' => [ 'Ir' => [ 'ContributionAnalysis' => [ 'Direction' => 'INCREASE|DECREASE|NEUTRAL', 'Factors' => [ [ 'FieldName' => '<string>', ], // ... ], 'SortType' => 'ABSOLUTE_DIFFERENCE|CONTRIBUTION_PERCENTAGE|DEVIATION_FROM_EXPECTED|PERCENTAGE_DIFFERENCE', 'TimeRanges' => [ 'EndRange' => [ 'AggMetrics' => [ [ 'Function' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'MetricOperand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], // ... ], 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'AggregationPartitionBy' => [ [ 'FieldName' => '<string>', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], 'Anchor' => [ 'AnchorType' => 'TODAY', 'Offset' => <integer>, 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], 'Constant' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'FilterClass' => 'ENFORCED_VALUE_FILTER|CONDITIONAL_VALUE_FILTER|NAMED_VALUE_FILTER', 'FilterType' => 'CATEGORY_FILTER|NUMERIC_EQUALITY_FILTER|NUMERIC_RANGE_FILTER|DATE_RANGE_FILTER|RELATIVE_DATE_FILTER|TOP_BOTTOM_FILTER|EQUALS|RANK_LIMIT_FILTER|ACCEPT_ALL_FILTER', 'Function' => 'CONTAINS|EXACT|STARTS_WITH|ENDS_WITH|CONTAINS_STRING|PREVIOUS|THIS|LAST|NEXT|NOW', 'Inclusive' => true || false, 'Inverse' => true || false, 'LastNextOffset' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'NullFilter' => 'ALL_VALUES|NON_NULLS_ONLY|NULLS_ONLY', 'OperandField' => [ 'Identity' => '<string>', // REQUIRED ], 'Range' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'SortDirection' => 'ASCENDING|DESCENDING', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'TopBottomLimit' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], ], 'StartRange' => [ 'AggMetrics' => [ [ 'Function' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'MetricOperand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], // ... ], 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'AggregationPartitionBy' => [ [ 'FieldName' => '<string>', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], 'Anchor' => [ 'AnchorType' => 'TODAY', 'Offset' => <integer>, 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], 'Constant' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'FilterClass' => 'ENFORCED_VALUE_FILTER|CONDITIONAL_VALUE_FILTER|NAMED_VALUE_FILTER', 'FilterType' => 'CATEGORY_FILTER|NUMERIC_EQUALITY_FILTER|NUMERIC_RANGE_FILTER|DATE_RANGE_FILTER|RELATIVE_DATE_FILTER|TOP_BOTTOM_FILTER|EQUALS|RANK_LIMIT_FILTER|ACCEPT_ALL_FILTER', 'Function' => 'CONTAINS|EXACT|STARTS_WITH|ENDS_WITH|CONTAINS_STRING|PREVIOUS|THIS|LAST|NEXT|NOW', 'Inclusive' => true || false, 'Inverse' => true || false, 'LastNextOffset' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'NullFilter' => 'ALL_VALUES|NON_NULLS_ONLY|NULLS_ONLY', 'OperandField' => [ 'Identity' => '<string>', // REQUIRED ], 'Range' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'SortDirection' => 'ASCENDING|DESCENDING', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'TopBottomLimit' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], ], ], ], 'Filters' => [ [ [ 'AggMetrics' => [ [ 'Function' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'MetricOperand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], // ... ], 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'AggregationPartitionBy' => [ [ 'FieldName' => '<string>', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], 'Anchor' => [ 'AnchorType' => 'TODAY', 'Offset' => <integer>, 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], 'Constant' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'FilterClass' => 'ENFORCED_VALUE_FILTER|CONDITIONAL_VALUE_FILTER|NAMED_VALUE_FILTER', 'FilterType' => 'CATEGORY_FILTER|NUMERIC_EQUALITY_FILTER|NUMERIC_RANGE_FILTER|DATE_RANGE_FILTER|RELATIVE_DATE_FILTER|TOP_BOTTOM_FILTER|EQUALS|RANK_LIMIT_FILTER|ACCEPT_ALL_FILTER', 'Function' => 'CONTAINS|EXACT|STARTS_WITH|ENDS_WITH|CONTAINS_STRING|PREVIOUS|THIS|LAST|NEXT|NOW', 'Inclusive' => true || false, 'Inverse' => true || false, 'LastNextOffset' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'NullFilter' => 'ALL_VALUES|NON_NULLS_ONLY|NULLS_ONLY', 'OperandField' => [ 'Identity' => '<string>', // REQUIRED ], 'Range' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], 'SortDirection' => 'ASCENDING|DESCENDING', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'TopBottomLimit' => [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Maximum' => '<string>', 'Minimum' => '<string>', 'Value' => '<string>', 'ValueList' => [ [ 'ConstantType' => 'SINGULAR|RANGE|COLLECTIVE', 'Value' => '<string>', ], // ... ], ], ], // ... ], // ... ], 'GroupByList' => [ [ 'DisplayFormat' => 'AUTO|PERCENT|CURRENCY|NUMBER|DATE|STRING', 'DisplayFormatOptions' => [ 'BlankCellFormat' => '<string>', 'CurrencySymbol' => '<string>', 'DateFormat' => '<string>', 'DecimalSeparator' => 'COMMA|DOT', 'FractionDigits' => <integer>, 'GroupingSeparator' => '<string>', 'NegativeFormat' => [ 'Prefix' => '<string>', 'Suffix' => '<string>', ], 'Prefix' => '<string>', 'Suffix' => '<string>', 'UnitScaler' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'UseBlankCellFormat' => true || false, 'UseGrouping' => true || false, ], 'FieldName' => [ 'Identity' => '<string>', // REQUIRED ], 'NamedEntity' => [ 'NamedEntityName' => '<string>', ], 'Sort' => [ 'Operand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], 'TimeGranularity' => 'SECOND|MINUTE|HOUR|DAY|WEEK|MONTH|QUARTER|YEAR', ], // ... ], 'Metrics' => [ [ 'CalculatedFieldReferences' => [ [ 'Identity' => '<string>', // REQUIRED ], // ... ], 'ComparisonMethod' => [ 'Period' => 'SECOND|MINUTE|HOUR|DAY|WEEK|MONTH|QUARTER|YEAR', 'Type' => 'DIFF|PERC_DIFF|DIFF_AS_PERC|POP_CURRENT_DIFF_AS_PERC|POP_CURRENT_DIFF|POP_OVERTIME_DIFF_AS_PERC|POP_OVERTIME_DIFF|PERCENT_OF_TOTAL|RUNNING_SUM|MOVING_AVERAGE', 'WindowSize' => <integer>, ], 'DisplayFormat' => 'AUTO|PERCENT|CURRENCY|NUMBER|DATE|STRING', 'DisplayFormatOptions' => [ 'BlankCellFormat' => '<string>', 'CurrencySymbol' => '<string>', 'DateFormat' => '<string>', 'DecimalSeparator' => 'COMMA|DOT', 'FractionDigits' => <integer>, 'GroupingSeparator' => '<string>', 'NegativeFormat' => [ 'Prefix' => '<string>', 'Suffix' => '<string>', ], 'Prefix' => '<string>', 'Suffix' => '<string>', 'UnitScaler' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'UseBlankCellFormat' => true || false, 'UseGrouping' => true || false, ], 'Expression' => '<string>', 'Function' => [ 'Aggregation' => 'SUM|MIN|MAX|COUNT|AVERAGE|DISTINCT_COUNT|STDEV|STDEVP|VAR|VARP|PERCENTILE|MEDIAN|PTD_SUM|PTD_MIN|PTD_MAX|PTD_COUNT|PTD_DISTINCT_COUNT|PTD_AVERAGE|COLUMN|CUSTOM', 'AggregationFunctionParameters' => ['<string>', ...], 'Period' => 'SECOND|MINUTE|HOUR|DAY|WEEK|MONTH|QUARTER|YEAR', 'PeriodField' => '<string>', ], 'MetricId' => [ 'Identity' => '<string>', // REQUIRED ], 'NamedEntity' => [ 'NamedEntityName' => '<string>', ], 'Operands' => [ [ 'Identity' => '<string>', // REQUIRED ], // ... ], ], // ... ], 'Sort' => [ 'Operand' => [ 'Identity' => '<string>', // REQUIRED ], 'SortDirection' => 'ASCENDING|DESCENDING', ], 'Visual' => [ 'type' => '<string>', ], ], 'Role' => 'PRIMARY|COMPLIMENTARY|MULTI_INTENT|FALLBACK|FRAGMENT', 'SupportingVisuals' => [ [...], // RECURSIVE // ... ], 'VisualId' => '<string>', ], 'Question' => '<string>', // REQUIRED 'Template' => [ 'Slots' => [ [ 'SlotId' => '<string>', 'VisualId' => '<string>', ], // ... ], 'TemplateType' => '<string>', ], ], // ... ], 'AwsAccountId' => '<string>', // REQUIRED 'TopicId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Answers
-
- Required: Yes
- Type: Array of CreateTopicReviewedAnswer structures
The definition of the Answers to be created.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the Amazon Web Services account that you want to create a reviewed answer in.
- TopicId
-
- Required: Yes
- Type: string
The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Result Syntax
[ 'InvalidAnswers' => [ [ 'AnswerId' => '<string>', 'Error' => 'INTERNAL_ERROR|MISSING_ANSWER|DATASET_DOES_NOT_EXIST|INVALID_DATASET_ARN|DUPLICATED_ANSWER|INVALID_DATA|MISSING_REQUIRED_FIELDS', ], // ... ], 'RequestId' => '<string>', 'Status' => <integer>, 'SucceededAnswers' => [ [ 'AnswerId' => '<string>', ], // ... ], 'TopicArn' => '<string>', 'TopicId' => '<string>', ]
Result Details
Members
- InvalidAnswers
-
- Type: Array of InvalidTopicReviewedAnswer structures
The definition of Answers that are invalid and not created.
- RequestId
-
- Type: string
The Amazon Web Services request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- SucceededAnswers
-
- Type: Array of SucceededTopicReviewedAnswer structures
The definition of Answers that are successfully created.
- TopicArn
-
- Type: string
The Amazon Resource Name (ARN) of the topic.
- TopicId
-
- Type: string
The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Errors
- AccessDeniedException:
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException:
One or more parameters has a value that isn't valid.
- ThrottlingException:
Access is throttled.
- ResourceNotFoundException:
One or more resources can't be found.
- InternalFailureException:
An internal failure occurred.
BatchDeleteTopicReviewedAnswer
$result = $client->batchDeleteTopicReviewedAnswer
([/* ... */]); $promise = $client->batchDeleteTopicReviewedAnswerAsync
([/* ... */]);
Deletes reviewed answers for Q Topic.
Parameter Syntax
$result = $client->batchDeleteTopicReviewedAnswer([ 'AnswerIds' => ['<string>', ...], 'AwsAccountId' => '<string>', // REQUIRED 'TopicId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AnswerIds
-
- Type: Array of strings
The Answer IDs of the Answers to be deleted.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the Amazon Web Services account that you want to delete a reviewed answers in.
- TopicId
-
- Required: Yes
- Type: string
The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Result Syntax
[ 'InvalidAnswers' => [ [ 'AnswerId' => '<string>', 'Error' => 'INTERNAL_ERROR|MISSING_ANSWER|DATASET_DOES_NOT_EXIST|INVALID_DATASET_ARN|DUPLICATED_ANSWER|INVALID_DATA|MISSING_REQUIRED_FIELDS', ], // ... ], 'RequestId' => '<string>', 'Status' => <integer>, 'SucceededAnswers' => [ [ 'AnswerId' => '<string>', ], // ... ], 'TopicArn' => '<string>', 'TopicId' => '<string>', ]
Result Details
Members
- InvalidAnswers
-
- Type: Array of InvalidTopicReviewedAnswer structures
The definition of Answers that are invalid and not deleted.
- RequestId
-
- Type: string
The Amazon Web Services request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- SucceededAnswers
-
- Type: Array of SucceededTopicReviewedAnswer structures
The definition of Answers that are successfully deleted.
- TopicArn
-
- Type: string
The Amazon Resource Name (ARN) of the topic.
- TopicId
-
- Type: string
The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Errors
- AccessDeniedException:
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException:
One or more parameters has a value that isn't valid.
- ThrottlingException:
Access is throttled.
- ResourceNotFoundException:
One or more resources can't be found.
- ConflictException:
Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException:
An internal failure occurred.
CancelIngestion
$result = $client->cancelIngestion
([/* ... */]); $promise = $client->cancelIngestionAsync
([/* ... */]);
Cancels an ongoing ingestion of data into SPICE.
Parameter Syntax
$result = $client->cancelIngestion([ 'AwsAccountId' => '<string>', // REQUIRED 'DataSetId' => '<string>', // REQUIRED 'IngestionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The Amazon Web Services account ID.
- DataSetId
-
- Required: Yes
- Type: string
The ID of the dataset used in the ingestion.
- IngestionId
-
- Required: Yes
- Type: string
An ID for the ingestion.
Result Syntax
[ 'Arn' => '<string>', 'IngestionId' => '<string>', 'RequestId' => '<string>', 'Status' => <integer>, ]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the data ingestion.
- IngestionId
-
- Type: string
An ID for the ingestion.
- RequestId
-
- Type: string
The Amazon Web Services request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
Errors
- AccessDeniedException:
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException:
One or more parameters has a value that isn't valid.
- ResourceNotFoundException:
One or more resources can't be found.
- ThrottlingException:
Access is throttled.
- ResourceExistsException:
The resource specified already exists.
- InternalFailureException:
An internal failure occurred.
CreateAccountCustomization
$result = $client->createAccountCustomization
([/* ... */]); $promise = $client->createAccountCustomizationAsync
([/* ... */]);
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions
API operation. To share the theme, grant permissions by using the UpdateThemePermissions
API operation.
Parameter Syntax
$result = $client->createAccountCustomization([ 'AccountCustomization' => [ // REQUIRED 'DefaultEmailCustomizationTemplate' => '<string>', 'DefaultTheme' => '<string>', ], 'AwsAccountId' => '<string>', // REQUIRED 'Namespace' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- AccountCustomization
-
- Required: Yes
- Type: AccountCustomization structure
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace.
For example, you can add a default theme by setting
AccountCustomization
to the midnight theme:"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }
. Or, you can add a custom theme by specifying"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }
. - AwsAccountId
-
- Required: Yes
- Type: string
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
- Namespace
-
- Type: string
The Amazon QuickSight namespace that you want to add customizations to.
- Tags
-
- Type: Array of Tag structures
A list of the tags that you want to attach to this resource.
Result Syntax
[ 'AccountCustomization' => [ 'DefaultEmailCustomizationTemplate' => '<string>', 'DefaultTheme' => '<string>', ], 'Arn' => '<string>', 'AwsAccountId' => '<string>', 'Namespace' => '<string>', 'RequestId' => '<string>', 'Status' => <integer>, ]
Result Details
Members
- AccountCustomization
-
- Type: AccountCustomization structure
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.
- AwsAccountId
-
- Type: string
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
- Namespace
-
- Type: string
The namespace associated with the customization you're creating.
- RequestId
-
- Type: string
The Amazon Web Services request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
Errors
- AccessDeniedException:
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException:
Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException:
One or more parameters has a value that isn't valid.
- ResourceExistsException:
The resource specified already exists.
- ResourceNotFoundException:
One or more resources can't be found.
- ThrottlingException:
Access is throttled.
- InternalFailureException:
An internal failure occurred.
- ResourceUnavailableException:
This resource is currently unavailable.
CreateAccountSubscription
$result = $client->createAccountSubscription
([/* ... */]); $promise = $client->createAccountSubscriptionAsync
([/* ... */]);
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and CreateAccountSubscription
actions, make sure that both actions are set to Allow
. If either action is set to Deny
, the Deny
action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
Parameter Syntax
$result = $client->createAccountSubscription([ 'AccountName' => '<string>', // REQUIRED 'ActiveDirectoryName' => '<string>', 'AdminGroup' => ['<string>', ...], 'AdminProGroup' => ['<string>', ...], 'AuthenticationMethod' => 'IAM_AND_QUICKSIGHT|IAM_ONLY|ACTIVE_DIRECTORY|IAM_IDENTITY_CENTER', // REQUIRED 'AuthorGroup' => ['<string>', ...], 'AuthorProGroup' => ['<string>', ...], 'AwsAccountId' => '<string>', // REQUIRED 'ContactNumber' => '<string>', 'DirectoryId' => '<string>', 'Edition' => 'STANDARD|ENTERPRISE|ENTERPRISE_AND_Q', 'EmailAddress' => '<string>', 'FirstName' => '<string>', 'IAMIdentityCenterInstanceArn' => '<string>', 'LastName' => '<string>', 'NotificationEmail' => '<string>', // REQUIRED 'ReaderGroup' => ['<string>', ...], 'ReaderProGroup' => ['<string>', ...], 'Realm' => '<string>', ]);
Parameter Details
Members
- AccountName
-
- Required: Yes
- Type: string
The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change
AccountName
value after the Amazon QuickSight account is created. - ActiveDirectoryName
-
- Type: string
The name of your Active Directory. This field is required if
ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account. - AdminGroup
-
- Type: Array of strings
The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the
AdminProGroup
field is required ifACTIVE_DIRECTORY
orIAM_IDENTITY_CENTER
is the selected authentication method of the new Amazon QuickSight account.For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
- AdminProGroup
-
- Type: Array of strings
The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the
AdminGroup
field is required ifACTIVE_DIRECTORY
orIAM_IDENTITY_CENTER
is the selected authentication method of the new Amazon QuickSight account.For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
- AuthenticationMethod
-
- Required: Yes
- Type: string
The method that you want to use to authenticate your Amazon QuickSight account.
If you choose
ACTIVE_DIRECTORY
, provide anActiveDirectoryName
and anAdminGroup
associated with your Active Directory.If you choose
IAM_IDENTITY_CENTER
, provide anAdminGroup
associated with your IAM Identity Center account. - AuthorGroup
-
- Type: Array of strings
The author group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
- AuthorProGroup
-
- Type: Array of strings
The author pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
- AwsAccountId
-
- Required: Yes
- Type: string
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
- ContactNumber
-
- Type: string
A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account. - DirectoryId
-
- Type: string
The ID of the Active Directory that is associated with your Amazon QuickSight account.
- Edition
-
- Type: string
The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from
ENTERPRISE
orENTERPRISE_AND_Q
.If you choose
ENTERPRISE_AND_Q
, the following parameters are required:-
FirstName
-
LastName
-
EmailAddress
-
ContactNumber
- EmailAddress
-
- Type: string
The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account. - FirstName
-
- Type: string
The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account. - IAMIdentityCenterInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) for the IAM Identity Center instance.
- LastName
-
- Type: string
The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account. - NotificationEmail
-
- Required: Yes
- Type: string
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
- ReaderGroup
-
- Type: Array of strings
The reader group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
- ReaderProGroup
-
- Type: Array of strings
The reader pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
- Realm
-
- Type: string
The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if
ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account.
Result Syntax
[ 'RequestId' => '<string>', 'SignupResponse' => [ 'IAMUser' => true || false, 'accountName' => '<string>', 'directoryType' => '<string>', 'userLoginName' => '<string>', ], 'Status' => <integer>, ]
Result Details
Members
- RequestId
-
- Type: string
The Amazon Web Services request ID for this operation.
- SignupResponse
-
- Type: SignupResponse structure
A
SignupResponse
object that returns information about a newly created Amazon QuickSight account. - Status
-
- Type: int
The HTTP status of the request.
Errors
- AccessDeniedException:
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException:
One or more parameters has a value that isn't valid.
- ResourceNotFoundException:
One or more resources can't be found.
- ThrottlingException:
Access is throttled.
- ResourceExistsException:
The resource specified already exists.
- PreconditionNotMetException:
One or more preconditions aren't met.
- ConflictException:
Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException:
An internal failure occurred.
- ResourceUnavailableException:
This resource is currently unavailable.
CreateAnalysis
$result = $client->createAnalysis
([/* ... */]); $promise = $client->createAnalysisAsync
([/* ... */]);
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition
.
Parameter Syntax
$result = $client->createAnalysis([ 'AnalysisId' => '<string>', // REQUIRED 'AwsAccountId' => '<string>', // REQUIRED 'Definition' => [ 'AnalysisDefaults' => [ 'DefaultNewSheetConfiguration' => [ // REQUIRED 'InteractiveLayoutConfiguration' => [ 'FreeForm' => [ 'CanvasSizeOptions' => [ // REQUIRED 'ScreenCanvasSizeOptions' => [ 'OptimizedViewPortWidth' => '<string>', // REQUIRED ], ], ], 'Grid' => [ 'CanvasSizeOptions' => [ // REQUIRED 'ScreenCanvasSizeOptions' => [ 'OptimizedViewPortWidth' => '<string>', 'ResizeOption' => 'FIXED|RESPONSIVE', // REQUIRED ], ], ], ], 'PaginatedLayoutConfiguration' => [ 'SectionBased' => [ 'CanvasSizeOptions' => [ // REQUIRED 'PaperCanvasSizeOptions' => [ 'PaperMargin' => [ 'Bottom' => '<string>', 'Left' => '<string>', 'Right' => '<string>', 'Top' => '<string>', ], 'PaperOrientation' => 'PORTRAIT|LANDSCAPE', 'PaperSize' => 'US_LETTER|US_LEGAL|US_TABLOID_LEDGER|A0|A1|A2|A3|A4|A5|JIS_B4|JIS_B5', ], ], ], ], 'SheetContentType' => 'PAGINATED|INTERACTIVE', ], ], 'CalculatedFields' => [ [ 'DataSetIdentifier' => '<string>', // REQUIRED 'Expression' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ], // ... ], 'ColumnConfigurations' => [ [ 'ColorsConfiguration' => [ 'CustomColors' => [ [ 'Color' => '<string>', // REQUIRED 'FieldValue' => '<string>', 'SpecialValue' => 'EMPTY|NULL|OTHER', ], // ... ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FormatConfiguration' => [ 'DateTimeFormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'NumberFormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'StringFormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'Role' => 'DIMENSION|MEASURE', ], // ... ], 'DataSetIdentifierDeclarations' => [ // REQUIRED [ 'DataSetArn' => '<string>', // REQUIRED 'Identifier' => '<string>', // REQUIRED ], // ... ], 'FilterGroups' => [ [ 'CrossDataset' => 'ALL_DATASETS|SINGLE_DATASET', // REQUIRED 'FilterGroupId' => '<string>', // REQUIRED 'Filters' => [ // REQUIRED [ 'CategoryFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Configuration' => [ // REQUIRED 'CustomFilterConfiguration' => [ 'CategoryValue' => '<string>', 'MatchOperator' => 'EQUALS|DOES_NOT_EQUAL|CONTAINS|DOES_NOT_CONTAIN|STARTS_WITH|ENDS_WITH', // REQUIRED 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'ParameterName' => '<string>', 'SelectAllOptions' => 'FILTER_ALL_VALUES', ], 'CustomFilterListConfiguration' => [ 'CategoryValues' => ['<string>', ...], 'MatchOperator' => 'EQUALS|DOES_NOT_EQUAL|CONTAINS|DOES_NOT_CONTAIN|STARTS_WITH|ENDS_WITH', // REQUIRED 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'SelectAllOptions' => 'FILTER_ALL_VALUES', ], 'FilterListConfiguration' => [ 'CategoryValues' => ['<string>', ...], 'MatchOperator' => 'EQUALS|DOES_NOT_EQUAL|CONTAINS|DOES_NOT_CONTAIN|STARTS_WITH|ENDS_WITH', // REQUIRED 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', 'SelectAllOptions' => 'FILTER_ALL_VALUES', ], ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], 'FilterId' => '<string>', // REQUIRED ], 'NestedFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FilterId' => '<string>', // REQUIRED 'IncludeInnerSet' => true || false, // REQUIRED 'InnerFilter' => [ // REQUIRED 'CategoryInnerFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Configuration' => [ // REQUIRED 'CustomFilterConfiguration' => [ 'CategoryValue' => '<string>', 'MatchOperator' => 'EQUALS|DOES_NOT_EQUAL|CONTAINS|DOES_NOT_CONTAIN|STARTS_WITH|ENDS_WITH', // REQUIRED 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'ParameterName' => '<string>', 'SelectAllOptions' => 'FILTER_ALL_VALUES', ], 'CustomFilterListConfiguration' => [ 'CategoryValues' => ['<string>', ...], 'MatchOperator' => 'EQUALS|DOES_NOT_EQUAL|CONTAINS|DOES_NOT_CONTAIN|STARTS_WITH|ENDS_WITH', // REQUIRED 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'SelectAllOptions' => 'FILTER_ALL_VALUES', ], 'FilterListConfiguration' => [ 'CategoryValues' => ['<string>', ...], 'MatchOperator' => 'EQUALS|DOES_NOT_EQUAL|CONTAINS|DOES_NOT_CONTAIN|STARTS_WITH|ENDS_WITH', // REQUIRED 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', 'SelectAllOptions' => 'FILTER_ALL_VALUES', ], ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], ], ], ], 'NumericEqualityFilter' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], 'FilterId' => '<string>', // REQUIRED 'MatchOperator' => 'EQUALS|DOES_NOT_EQUAL', // REQUIRED 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'ParameterName' => '<string>', 'SelectAllOptions' => 'FILTER_ALL_VALUES', 'Value' => <float>, ], 'NumericRangeFilter' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], 'FilterId' => '<string>', // REQUIRED 'IncludeMaximum' => true || false, 'IncludeMinimum' => true || false, 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'RangeMaximum' => [ 'Parameter' => '<string>', 'StaticValue' => <float>, ], 'RangeMinimum' => [ 'Parameter' => '<string>', 'StaticValue' => <float>, ], 'SelectAllOptions' => 'FILTER_ALL_VALUES', ], 'RelativeDatesFilter' => [ 'AnchorDateConfiguration' => [ // REQUIRED 'AnchorOption' => 'NOW', 'ParameterName' => '<string>', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], 'ExcludePeriodConfiguration' => [ 'Amount' => <integer>, // REQUIRED 'Granularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED 'Status' => 'ENABLED|DISABLED', ], 'FilterId' => '<string>', // REQUIRED 'MinimumGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'ParameterName' => '<string>', 'RelativeDateType' => 'PREVIOUS|THIS|LAST|NOW|NEXT', // REQUIRED 'RelativeDateValue' => <integer>, 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], 'TimeEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], 'FilterId' => '<string>', // REQUIRED 'ParameterName' => '<string>', 'RollingDate' => [ 'DataSetIdentifier' => '<string>', 'Expression' => '<string>', // REQUIRED ], 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'Value' => <integer || string || DateTime>, ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], 'ExcludePeriodConfiguration' => [ 'Amount' => <integer>, // REQUIRED 'Granularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED 'Status' => 'ENABLED|DISABLED', ], 'FilterId' => '<string>', // REQUIRED 'IncludeMaximum' => true || false, 'IncludeMinimum' => true || false, 'NullOption' => 'ALL_VALUES|NULLS_ONLY|NON_NULLS_ONLY', // REQUIRED 'RangeMaximumValue' => [ 'Parameter' => '<string>', 'RollingDate' => [ 'DataSetIdentifier' => '<string>', 'Expression' => '<string>', // REQUIRED ], 'StaticValue' => <integer || string || DateTime>, ], 'RangeMinimumValue' => [ 'Parameter' => '<string>', 'RollingDate' => [ 'DataSetIdentifier' => '<string>', 'Expression' => '<string>', // REQUIRED ], 'StaticValue' => <integer || string || DateTime>, ], 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], 'TopBottomFilter' => [ 'AggregationSortConfigurations' => [ // REQUIRED [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SortDirection' => 'ASC|DESC', // REQUIRED ], // ... ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DefaultFilterControlConfiguration' => [ 'ControlOptions' => [ // REQUIRED 'DefaultDateTimePickerOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'DefaultDropdownOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultListOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'DefaultRelativeDateTimeOptions' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultSliderOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'StepSize' => <float>, // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'DefaultTextAreaOptions' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], 'DefaultTextFieldOptions' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], ], ], 'Title' => '<string>', // REQUIRED ], 'FilterId' => '<string>', // REQUIRED 'Limit' => <integer>, 'ParameterName' => '<string>', 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], ], // ... ], 'ScopeConfiguration' => [ // REQUIRED 'AllSheets' => [ ], 'SelectedSheets' => [ 'SheetVisualScopingConfigurations' => [ [ 'Scope' => 'ALL_VISUALS|SELECTED_VISUALS', // REQUIRED 'SheetId' => '<string>', // REQUIRED 'VisualIds' => ['<string>', ...], ], // ... ], ], ], 'Status' => 'ENABLED|DISABLED', ], // ... ], 'Options' => [ 'Timezone' => '<string>', 'WeekStart' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', ], 'ParameterDeclarations' => [ [ 'DateTimeParameterDeclaration' => [ 'DefaultValues' => [ 'DynamicValue' => [ 'DefaultValueColumn' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'GroupNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'UserNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'RollingDate' => [ 'DataSetIdentifier' => '<string>', 'Expression' => '<string>', // REQUIRED ], 'StaticValues' => [<integer || string || DateTime>, ...], ], 'MappedDataSetParameters' => [ [ 'DataSetIdentifier' => '<string>', // REQUIRED 'DataSetParameterName' => '<string>', // REQUIRED ], // ... ], 'Name' => '<string>', // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'ValueWhenUnset' => [ 'CustomValue' => <integer || string || DateTime>, 'ValueWhenUnsetOption' => 'RECOMMENDED_VALUE|NULL', ], ], 'DecimalParameterDeclaration' => [ 'DefaultValues' => [ 'DynamicValue' => [ 'DefaultValueColumn' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'GroupNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'UserNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'StaticValues' => [<float>, ...], ], 'MappedDataSetParameters' => [ [ 'DataSetIdentifier' => '<string>', // REQUIRED 'DataSetParameterName' => '<string>', // REQUIRED ], // ... ], 'Name' => '<string>', // REQUIRED 'ParameterValueType' => 'MULTI_VALUED|SINGLE_VALUED', // REQUIRED 'ValueWhenUnset' => [ 'CustomValue' => <float>, 'ValueWhenUnsetOption' => 'RECOMMENDED_VALUE|NULL', ], ], 'IntegerParameterDeclaration' => [ 'DefaultValues' => [ 'DynamicValue' => [ 'DefaultValueColumn' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'GroupNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'UserNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'StaticValues' => [<integer>, ...], ], 'MappedDataSetParameters' => [ [ 'DataSetIdentifier' => '<string>', // REQUIRED 'DataSetParameterName' => '<string>', // REQUIRED ], // ... ], 'Name' => '<string>', // REQUIRED 'ParameterValueType' => 'MULTI_VALUED|SINGLE_VALUED', // REQUIRED 'ValueWhenUnset' => [ 'CustomValue' => <integer>, 'ValueWhenUnsetOption' => 'RECOMMENDED_VALUE|NULL', ], ], 'StringParameterDeclaration' => [ 'DefaultValues' => [ 'DynamicValue' => [ 'DefaultValueColumn' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'GroupNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'UserNameColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'StaticValues' => ['<string>', ...], ], 'MappedDataSetParameters' => [ [ 'DataSetIdentifier' => '<string>', // REQUIRED 'DataSetParameterName' => '<string>', // REQUIRED ], // ... ], 'Name' => '<string>', // REQUIRED 'ParameterValueType' => 'MULTI_VALUED|SINGLE_VALUED', // REQUIRED 'ValueWhenUnset' => [ 'CustomValue' => '<string>', 'ValueWhenUnsetOption' => 'RECOMMENDED_VALUE|NULL', ], ], ], // ... ], 'QueryExecutionOptions' => [ 'QueryExecutionMode' => 'AUTO|MANUAL', ], 'Sheets' => [ [ 'ContentType' => 'PAGINATED|INTERACTIVE', 'Description' => '<string>', 'FilterControls' => [ [ 'CrossSheet' => [ 'CascadingControlConfiguration' => [ 'SourceControls' => [ [ 'ColumnToMatch' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceSheetControlId' => '<string>', ], // ... ], ], 'FilterControlId' => '<string>', // REQUIRED 'SourceFilterId' => '<string>', // REQUIRED ], 'DateTimePicker' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'FilterControlId' => '<string>', // REQUIRED 'SourceFilterId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED 'Type' => 'SINGLE_VALUED|DATE_RANGE', ], 'Dropdown' => [ 'CascadingControlConfiguration' => [ 'SourceControls' => [ [ 'ColumnToMatch' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceSheetControlId' => '<string>', ], // ... ], ], 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'FilterControlId' => '<string>', // REQUIRED 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'SourceFilterId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'List' => [ 'CascadingControlConfiguration' => [ 'SourceControls' => [ [ 'ColumnToMatch' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceSheetControlId' => '<string>', ], // ... ], ], 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'FilterControlId' => '<string>', // REQUIRED 'SelectableValues' => [ 'Values' => ['<string>', ...], ], 'SourceFilterId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'RelativeDateTime' => [ 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'DateTimeFormat' => '<string>', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'FilterControlId' => '<string>', // REQUIRED 'SourceFilterId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED ], 'Slider' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'FilterControlId' => '<string>', // REQUIRED 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'SourceFilterId' => '<string>', // REQUIRED 'StepSize' => <float>, // REQUIRED 'Title' => '<string>', // REQUIRED 'Type' => 'SINGLE_POINT|RANGE', ], 'TextArea' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'FilterControlId' => '<string>', // REQUIRED 'SourceFilterId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED ], 'TextField' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'FilterControlId' => '<string>', // REQUIRED 'SourceFilterId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED ], ], // ... ], 'Images' => [ [ 'Actions' => [ [ 'ActionOperations' => [ // REQUIRED [ 'NavigationOperation' => [ 'LocalNavigationConfiguration' => [ 'TargetSheetId' => '<string>', // REQUIRED ], ], 'SetParametersOperation' => [ 'ParameterValueConfigurations' => [ // REQUIRED [ 'DestinationParameterName' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'CustomValuesConfiguration' => [ 'CustomValues' => [ // REQUIRED 'DateTimeValues' => [<integer || string || DateTime>, ...], 'DecimalValues' => [<float>, ...], 'IntegerValues' => [<integer>, ...], 'StringValues' => ['<string>', ...], ], 'IncludeNullValue' => true || false, ], 'SelectAllValueOptions' => 'ALL_VALUES', 'SourceColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceField' => '<string>', 'SourceParameterName' => '<string>', ], ], // ... ], ], 'URLOperation' => [ 'URLTarget' => 'NEW_TAB|NEW_WINDOW|SAME_TAB', // REQUIRED 'URLTemplate' => '<string>', // REQUIRED ], ], // ... ], 'CustomActionId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'ENABLED|DISABLED', 'Trigger' => 'CLICK|MENU', // REQUIRED ], // ... ], 'ImageContentAltText' => '<string>', 'Interactions' => [ 'ImageMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], ], 'Scaling' => [ 'ScalingType' => 'SCALE_TO_WIDTH|SCALE_TO_HEIGHT|SCALE_TO_CONTAINER|SCALE_NONE', ], 'SheetImageId' => '<string>', // REQUIRED 'Source' => [ // REQUIRED 'SheetImageStaticFileSource' => [ 'StaticFileId' => '<string>', // REQUIRED ], ], 'Tooltip' => [ 'TooltipText' => [ 'PlainText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'Layouts' => [ [ 'Configuration' => [ // REQUIRED 'FreeFormLayout' => [ 'CanvasSizeOptions' => [ 'ScreenCanvasSizeOptions' => [ 'OptimizedViewPortWidth' => '<string>', // REQUIRED ], ], 'Elements' => [ // REQUIRED [ 'BackgroundStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'BorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ElementId' => '<string>', // REQUIRED 'ElementType' => 'VISUAL|FILTER_CONTROL|PARAMETER_CONTROL|TEXT_BOX|IMAGE', // REQUIRED 'Height' => '<string>', // REQUIRED 'LoadingAnimation' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'RenderingRules' => [ [ 'ConfigurationOverrides' => [ // REQUIRED 'Visibility' => 'HIDDEN|VISIBLE', ], 'Expression' => '<string>', // REQUIRED ], // ... ], 'SelectedBorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', // REQUIRED 'XAxisLocation' => '<string>', // REQUIRED 'YAxisLocation' => '<string>', // REQUIRED ], // ... ], ], 'GridLayout' => [ 'CanvasSizeOptions' => [ 'ScreenCanvasSizeOptions' => [ 'OptimizedViewPortWidth' => '<string>', 'ResizeOption' => 'FIXED|RESPONSIVE', // REQUIRED ], ], 'Elements' => [ // REQUIRED [ 'ColumnIndex' => <integer>, 'ColumnSpan' => <integer>, // REQUIRED 'ElementId' => '<string>', // REQUIRED 'ElementType' => 'VISUAL|FILTER_CONTROL|PARAMETER_CONTROL|TEXT_BOX|IMAGE', // REQUIRED 'RowIndex' => <integer>, 'RowSpan' => <integer>, // REQUIRED ], // ... ], ], 'SectionBasedLayout' => [ 'BodySections' => [ // REQUIRED [ 'Content' => [ // REQUIRED 'Layout' => [ 'FreeFormLayout' => [ // REQUIRED 'Elements' => [ // REQUIRED [ 'BackgroundStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'BorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ElementId' => '<string>', // REQUIRED 'ElementType' => 'VISUAL|FILTER_CONTROL|PARAMETER_CONTROL|TEXT_BOX|IMAGE', // REQUIRED 'Height' => '<string>', // REQUIRED 'LoadingAnimation' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'RenderingRules' => [ [ 'ConfigurationOverrides' => [ // REQUIRED 'Visibility' => 'HIDDEN|VISIBLE', ], 'Expression' => '<string>', // REQUIRED ], // ... ], 'SelectedBorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', // REQUIRED 'XAxisLocation' => '<string>', // REQUIRED 'YAxisLocation' => '<string>', // REQUIRED ], // ... ], ], ], ], 'PageBreakConfiguration' => [ 'After' => [ 'Status' => 'ENABLED|DISABLED', ], ], 'RepeatConfiguration' => [ 'DimensionConfigurations' => [ [ 'DynamicCategoryDimensionConfiguration' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Limit' => <integer>, 'SortByMetrics' => [ [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], // ... ], ], 'DynamicNumericDimensionConfiguration' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Limit' => <integer>, 'SortByMetrics' => [ [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], // ... ], ], ], // ... ], 'NonRepeatingVisuals' => ['<string>', ...], 'PageBreakConfiguration' => [ 'After' => [ 'Status' => 'ENABLED|DISABLED', ], ], ], 'SectionId' => '<string>', // REQUIRED 'Style' => [ 'Height' => '<string>', 'Padding' => [ 'Bottom' => '<string>', 'Left' => '<string>', 'Right' => '<string>', 'Top' => '<string>', ], ], ], // ... ], 'CanvasSizeOptions' => [ // REQUIRED 'PaperCanvasSizeOptions' => [ 'PaperMargin' => [ 'Bottom' => '<string>', 'Left' => '<string>', 'Right' => '<string>', 'Top' => '<string>', ], 'PaperOrientation' => 'PORTRAIT|LANDSCAPE', 'PaperSize' => 'US_LETTER|US_LEGAL|US_TABLOID_LEDGER|A0|A1|A2|A3|A4|A5|JIS_B4|JIS_B5', ], ], 'FooterSections' => [ // REQUIRED [ 'Layout' => [ // REQUIRED 'FreeFormLayout' => [ // REQUIRED 'Elements' => [ // REQUIRED [ 'BackgroundStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'BorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ElementId' => '<string>', // REQUIRED 'ElementType' => 'VISUAL|FILTER_CONTROL|PARAMETER_CONTROL|TEXT_BOX|IMAGE', // REQUIRED 'Height' => '<string>', // REQUIRED 'LoadingAnimation' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'RenderingRules' => [ [ 'ConfigurationOverrides' => [ // REQUIRED 'Visibility' => 'HIDDEN|VISIBLE', ], 'Expression' => '<string>', // REQUIRED ], // ... ], 'SelectedBorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', // REQUIRED 'XAxisLocation' => '<string>', // REQUIRED 'YAxisLocation' => '<string>', // REQUIRED ], // ... ], ], ], 'SectionId' => '<string>', // REQUIRED 'Style' => [ 'Height' => '<string>', 'Padding' => [ 'Bottom' => '<string>', 'Left' => '<string>', 'Right' => '<string>', 'Top' => '<string>', ], ], ], // ... ], 'HeaderSections' => [ // REQUIRED [ 'Layout' => [ // REQUIRED 'FreeFormLayout' => [ // REQUIRED 'Elements' => [ // REQUIRED [ 'BackgroundStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'BorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ElementId' => '<string>', // REQUIRED 'ElementType' => 'VISUAL|FILTER_CONTROL|PARAMETER_CONTROL|TEXT_BOX|IMAGE', // REQUIRED 'Height' => '<string>', // REQUIRED 'LoadingAnimation' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'RenderingRules' => [ [ 'ConfigurationOverrides' => [ // REQUIRED 'Visibility' => 'HIDDEN|VISIBLE', ], 'Expression' => '<string>', // REQUIRED ], // ... ], 'SelectedBorderStyle' => [ 'Color' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', // REQUIRED 'XAxisLocation' => '<string>', // REQUIRED 'YAxisLocation' => '<string>', // REQUIRED ], // ... ], ], ], 'SectionId' => '<string>', // REQUIRED 'Style' => [ 'Height' => '<string>', 'Padding' => [ 'Bottom' => '<string>', 'Left' => '<string>', 'Right' => '<string>', 'Top' => '<string>', ], ], ], // ... ], ], ], ], // ... ], 'Name' => '<string>', 'ParameterControls' => [ [ 'DateTimePicker' => [ 'DisplayOptions' => [ 'DateIconVisibility' => 'HIDDEN|VISIBLE', 'DateTimeFormat' => '<string>', 'HelperTextVisibility' => 'HIDDEN|VISIBLE', 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'ParameterControlId' => '<string>', // REQUIRED 'SourceParameterName' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED ], 'Dropdown' => [ 'CascadingControlConfiguration' => [ 'SourceControls' => [ [ 'ColumnToMatch' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceSheetControlId' => '<string>', ], // ... ], ], 'CommitMode' => 'AUTO|MANUAL', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'ParameterControlId' => '<string>', // REQUIRED 'SelectableValues' => [ 'LinkToDataSetColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Values' => ['<string>', ...], ], 'SourceParameterName' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'List' => [ 'CascadingControlConfiguration' => [ 'SourceControls' => [ [ 'ColumnToMatch' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceSheetControlId' => '<string>', ], // ... ], ], 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SearchOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'SelectAllOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'ParameterControlId' => '<string>', // REQUIRED 'SelectableValues' => [ 'LinkToDataSetColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Values' => ['<string>', ...], ], 'SourceParameterName' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED 'Type' => 'MULTI_SELECT|SINGLE_SELECT', ], 'Slider' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'MaximumValue' => <float>, // REQUIRED 'MinimumValue' => <float>, // REQUIRED 'ParameterControlId' => '<string>', // REQUIRED 'SourceParameterName' => '<string>', // REQUIRED 'StepSize' => <float>, // REQUIRED 'Title' => '<string>', // REQUIRED ], 'TextArea' => [ 'Delimiter' => '<string>', 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'ParameterControlId' => '<string>', // REQUIRED 'SourceParameterName' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED ], 'TextField' => [ 'DisplayOptions' => [ 'InfoIconLabelOptions' => [ 'InfoIconText' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PlaceholderOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'TitleOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'ParameterControlId' => '<string>', // REQUIRED 'SourceParameterName' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED ], ], // ... ], 'SheetControlLayouts' => [ [ 'Configuration' => [ // REQUIRED 'GridLayout' => [ 'CanvasSizeOptions' => [ 'ScreenCanvasSizeOptions' => [ 'OptimizedViewPortWidth' => '<string>', 'ResizeOption' => 'FIXED|RESPONSIVE', // REQUIRED ], ], 'Elements' => [ // REQUIRED [ 'ColumnIndex' => <integer>, 'ColumnSpan' => <integer>, // REQUIRED 'ElementId' => '<string>', // REQUIRED 'ElementType' => 'VISUAL|FILTER_CONTROL|PARAMETER_CONTROL|TEXT_BOX|IMAGE', // REQUIRED 'RowIndex' => <integer>, 'RowSpan' => <integer>, // REQUIRED ], // ... ], ], ], ], // ... ], 'SheetId' => '<string>', // REQUIRED 'TextBoxes' => [ [ 'Content' => '<string>', 'SheetTextBoxId' => '<string>', // REQUIRED ], // ... ], 'Title' => '<string>', 'Visuals' => [ [ 'BarChartVisual' => [ 'Actions' => [ [ 'ActionOperations' => [ // REQUIRED [ 'FilterOperation' => [ 'SelectedFieldsConfiguration' => [ // REQUIRED 'SelectedColumns' => [ [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'SelectedFieldOptions' => 'ALL_FIELDS', 'SelectedFields' => ['<string>', ...], ], 'TargetVisualsConfiguration' => [ // REQUIRED 'SameSheetTargetVisualConfiguration' => [ 'TargetVisualOptions' => 'ALL_VISUALS', 'TargetVisuals' => ['<string>', ...], ], ], ], 'NavigationOperation' => [ 'LocalNavigationConfiguration' => [ 'TargetSheetId' => '<string>', // REQUIRED ], ], 'SetParametersOperation' => [ 'ParameterValueConfigurations' => [ // REQUIRED [ 'DestinationParameterName' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'CustomValuesConfiguration' => [ 'CustomValues' => [ // REQUIRED 'DateTimeValues' => [<integer || string || DateTime>, ...], 'DecimalValues' => [<float>, ...], 'IntegerValues' => [<integer>, ...], 'StringValues' => ['<string>', ...], ], 'IncludeNullValue' => true || false, ], 'SelectAllValueOptions' => 'ALL_VALUES', 'SourceColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceField' => '<string>', 'SourceParameterName' => '<string>', ], ], // ... ], ], 'URLOperation' => [ 'URLTarget' => 'NEW_TAB|NEW_WINDOW|SAME_TAB', // REQUIRED 'URLTemplate' => '<string>', // REQUIRED ], ], // ... ], 'CustomActionId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'ENABLED|DISABLED', 'Trigger' => 'DATA_POINT_CLICK|DATA_POINT_MENU', // REQUIRED ], // ... ], 'ChartConfiguration' => [ 'BarsArrangement' => 'CLUSTERED|STACKED|STACKED_PERCENT', 'CategoryAxis' => [ 'AxisLineVisibility' => 'HIDDEN|VISIBLE', 'AxisOffset' => '<string>', 'DataOptions' => [ 'DateAxisOptions' => [ 'MissingDateVisibility' => 'HIDDEN|VISIBLE', ], 'NumericAxisOptions' => [ 'Range' => [ 'DataDriven' => [ ], 'MinMax' => [ 'Maximum' => <float>, 'Minimum' => <float>, ], ], 'Scale' => [ 'Linear' => [ 'StepCount' => <integer>, 'StepSize' => <float>, ], 'Logarithmic' => [ 'Base' => <float>, ], ], ], ], 'GridLineVisibility' => 'HIDDEN|VISIBLE', 'ScrollbarOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', 'VisibleRange' => [ 'PercentRange' => [ 'From' => <float>, 'To' => <float>, ], ], ], 'TickLabelOptions' => [ 'LabelOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'RotationAngle' => <float>, ], ], 'CategoryLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ColorLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ContributionAnalysisDefaults' => [ [ 'ContributorDimensions' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'MeasureFieldId' => '<string>', // REQUIRED ], // ... ], 'DataLabels' => [ 'CategoryLabelVisibility' => 'HIDDEN|VISIBLE', 'DataLabelTypes' => [ [ 'DataPathLabelType' => [ 'FieldId' => '<string>', 'FieldValue' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldLabelType' => [ 'FieldId' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'MaximumLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'MinimumLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'RangeEndsLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'LabelColor' => '<string>', 'LabelContent' => 'VALUE|PERCENT|VALUE_AND_PERCENT', 'LabelFontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'MeasureLabelVisibility' => 'HIDDEN|VISIBLE', 'Overlap' => 'DISABLE_OVERLAP|ENABLE_OVERLAP', 'Position' => 'INSIDE|OUTSIDE|LEFT|TOP|BOTTOM|RIGHT', 'TotalsVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldWells' => [ 'BarChartAggregatedFieldWells' => [ 'Category' => [ [ 'CategoricalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'DateDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DateGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'NumericalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], ], // ... ], 'Colors' => [ [ 'CategoricalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'DateDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DateGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'NumericalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], ], // ... ], 'SmallMultiples' => [ [ 'CategoricalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'DateDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DateGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'NumericalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], ], // ... ], 'Values' => [ [ 'CalculatedMeasureField' => [ 'Expression' => '<string>', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], 'CategoricalMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'DateMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'NumericalMeasureField' => [ 'AggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], ], // ... ], ], ], 'Interactions' => [ 'ContextMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], 'VisualMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], ], 'Legend' => [ 'Height' => '<string>', 'Position' => 'AUTO|RIGHT|BOTTOM|TOP', 'Title' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'ValueFontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', ], 'Orientation' => 'HORIZONTAL|VERTICAL', 'ReferenceLines' => [ [ 'DataConfiguration' => [ // REQUIRED 'AxisBinding' => 'PRIMARY_YAXIS|SECONDARY_YAXIS', 'DynamicConfiguration' => [ 'Calculation' => [ // REQUIRED 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'MeasureAggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], ], 'SeriesType' => 'BAR|LINE', 'StaticConfiguration' => [ 'Value' => <float>, // REQUIRED ], ], 'LabelConfiguration' => [ 'CustomLabelConfiguration' => [ 'CustomLabel' => '<string>', // REQUIRED ], 'FontColor' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'HorizontalPosition' => 'LEFT|CENTER|RIGHT', 'ValueLabelConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], 'RelativePosition' => 'BEFORE_CUSTOM_LABEL|AFTER_CUSTOM_LABEL', ], 'VerticalPosition' => 'ABOVE|BELOW', ], 'Status' => 'ENABLED|DISABLED', 'StyleConfiguration' => [ 'Color' => '<string>', 'Pattern' => 'SOLID|DASHED|DOTTED', ], ], // ... ], 'SmallMultiplesOptions' => [ 'MaxVisibleColumns' => <integer>, 'MaxVisibleRows' => <integer>, 'PanelConfiguration' => [ 'BackgroundColor' => '<string>', 'BackgroundVisibility' => 'HIDDEN|VISIBLE', 'BorderColor' => '<string>', 'BorderStyle' => 'SOLID|DASHED|DOTTED', 'BorderThickness' => '<string>', 'BorderVisibility' => 'HIDDEN|VISIBLE', 'GutterSpacing' => '<string>', 'GutterVisibility' => 'HIDDEN|VISIBLE', 'Title' => [ 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'HorizontalTextAlignment' => 'LEFT|CENTER|RIGHT|AUTO', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'XAxis' => [ 'Placement' => 'OUTSIDE|INSIDE', 'Scale' => 'SHARED|INDEPENDENT', ], 'YAxis' => [ 'Placement' => 'OUTSIDE|INSIDE', 'Scale' => 'SHARED|INDEPENDENT', ], ], 'SortConfiguration' => [ 'CategoryItemsLimit' => [ 'ItemsLimit' => <integer>, 'OtherCategories' => 'INCLUDE|EXCLUDE', ], 'CategorySort' => [ [ 'ColumnSort' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'FieldSort' => [ 'Direction' => 'ASC|DESC', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], ], // ... ], 'ColorItemsLimit' => [ 'ItemsLimit' => <integer>, 'OtherCategories' => 'INCLUDE|EXCLUDE', ], 'ColorSort' => [ [ 'ColumnSort' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'FieldSort' => [ 'Direction' => 'ASC|DESC', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], ], // ... ], 'SmallMultiplesLimitConfiguration' => [ 'ItemsLimit' => <integer>, 'OtherCategories' => 'INCLUDE|EXCLUDE', ], 'SmallMultiplesSort' => [ [ 'ColumnSort' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'FieldSort' => [ 'Direction' => 'ASC|DESC', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], ], // ... ], ], 'Tooltip' => [ 'FieldBasedTooltip' => [ 'AggregationVisibility' => 'HIDDEN|VISIBLE', 'TooltipFields' => [ [ 'ColumnTooltipItem' => [ 'Aggregation' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldTooltipItem' => [ 'FieldId' => '<string>', // REQUIRED 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'TooltipTitleType' => 'NONE|PRIMARY_VALUE', ], 'SelectedTooltipType' => 'BASIC|DETAILED', 'TooltipVisibility' => 'HIDDEN|VISIBLE', ], 'ValueAxis' => [ 'AxisLineVisibility' => 'HIDDEN|VISIBLE', 'AxisOffset' => '<string>', 'DataOptions' => [ 'DateAxisOptions' => [ 'MissingDateVisibility' => 'HIDDEN|VISIBLE', ], 'NumericAxisOptions' => [ 'Range' => [ 'DataDriven' => [ ], 'MinMax' => [ 'Maximum' => <float>, 'Minimum' => <float>, ], ], 'Scale' => [ 'Linear' => [ 'StepCount' => <integer>, 'StepSize' => <float>, ], 'Logarithmic' => [ 'Base' => <float>, ], ], ], ], 'GridLineVisibility' => 'HIDDEN|VISIBLE', 'ScrollbarOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', 'VisibleRange' => [ 'PercentRange' => [ 'From' => <float>, 'To' => <float>, ], ], ], 'TickLabelOptions' => [ 'LabelOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'RotationAngle' => <float>, ], ], 'ValueLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'VisualPalette' => [ 'ChartColor' => '<string>', 'ColorMap' => [ [ 'Color' => '<string>', // REQUIRED 'Element' => [ // REQUIRED 'DataPathType' => [ 'PivotTableDataPathType' => 'HIERARCHY_ROWS_LAYOUT_COLUMN|MULTIPLE_ROW_METRICS_COLUMN|EMPTY_COLUMN_HEADER|COUNT_METRIC_COLUMN', ], 'FieldId' => '<string>', 'FieldValue' => '<string>', ], 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], ], ], 'ColumnHierarchies' => [ [ 'DateTimeHierarchy' => [ 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'ExplicitHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'PredefinedHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], ], // ... ], 'Subtitle' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'Title' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'VisualContentAltText' => '<string>', 'VisualId' => '<string>', // REQUIRED ], 'BoxPlotVisual' => [ 'Actions' => [ [ 'ActionOperations' => [ // REQUIRED [ 'FilterOperation' => [ 'SelectedFieldsConfiguration' => [ // REQUIRED 'SelectedColumns' => [ [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'SelectedFieldOptions' => 'ALL_FIELDS', 'SelectedFields' => ['<string>', ...], ], 'TargetVisualsConfiguration' => [ // REQUIRED 'SameSheetTargetVisualConfiguration' => [ 'TargetVisualOptions' => 'ALL_VISUALS', 'TargetVisuals' => ['<string>', ...], ], ], ], 'NavigationOperation' => [ 'LocalNavigationConfiguration' => [ 'TargetSheetId' => '<string>', // REQUIRED ], ], 'SetParametersOperation' => [ 'ParameterValueConfigurations' => [ // REQUIRED [ 'DestinationParameterName' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'CustomValuesConfiguration' => [ 'CustomValues' => [ // REQUIRED 'DateTimeValues' => [<integer || string || DateTime>, ...], 'DecimalValues' => [<float>, ...], 'IntegerValues' => [<integer>, ...], 'StringValues' => ['<string>', ...], ], 'IncludeNullValue' => true || false, ], 'SelectAllValueOptions' => 'ALL_VALUES', 'SourceColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceField' => '<string>', 'SourceParameterName' => '<string>', ], ], // ... ], ], 'URLOperation' => [ 'URLTarget' => 'NEW_TAB|NEW_WINDOW|SAME_TAB', // REQUIRED 'URLTemplate' => '<string>', // REQUIRED ], ], // ... ], 'CustomActionId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'ENABLED|DISABLED', 'Trigger' => 'DATA_POINT_CLICK|DATA_POINT_MENU', // REQUIRED ], // ... ], 'ChartConfiguration' => [ 'BoxPlotOptions' => [ 'AllDataPointsVisibility' => 'HIDDEN|VISIBLE', 'OutlierVisibility' => 'HIDDEN|VISIBLE', 'StyleOptions' => [ 'FillStyle' => 'SOLID|TRANSPARENT', ], ], 'CategoryAxis' => [ 'AxisLineVisibility' => 'HIDDEN|VISIBLE', 'AxisOffset' => '<string>', 'DataOptions' => [ 'DateAxisOptions' => [ 'MissingDateVisibility' => 'HIDDEN|VISIBLE', ], 'NumericAxisOptions' => [ 'Range' => [ 'DataDriven' => [ ], 'MinMax' => [ 'Maximum' => <float>, 'Minimum' => <float>, ], ], 'Scale' => [ 'Linear' => [ 'StepCount' => <integer>, 'StepSize' => <float>, ], 'Logarithmic' => [ 'Base' => <float>, ], ], ], ], 'GridLineVisibility' => 'HIDDEN|VISIBLE', 'ScrollbarOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', 'VisibleRange' => [ 'PercentRange' => [ 'From' => <float>, 'To' => <float>, ], ], ], 'TickLabelOptions' => [ 'LabelOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'RotationAngle' => <float>, ], ], 'CategoryLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldWells' => [ 'BoxPlotAggregatedFieldWells' => [ 'GroupBy' => [ [ 'CategoricalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'DateDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DateGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'NumericalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], ], // ... ], 'Values' => [ [ 'CalculatedMeasureField' => [ 'Expression' => '<string>', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], 'CategoricalMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'DateMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'NumericalMeasureField' => [ 'AggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], ], // ... ], ], ], 'Interactions' => [ 'ContextMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], 'VisualMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], ], 'Legend' => [ 'Height' => '<string>', 'Position' => 'AUTO|RIGHT|BOTTOM|TOP', 'Title' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'ValueFontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', ], 'PrimaryYAxisDisplayOptions' => [ 'AxisLineVisibility' => 'HIDDEN|VISIBLE', 'AxisOffset' => '<string>', 'DataOptions' => [ 'DateAxisOptions' => [ 'MissingDateVisibility' => 'HIDDEN|VISIBLE', ], 'NumericAxisOptions' => [ 'Range' => [ 'DataDriven' => [ ], 'MinMax' => [ 'Maximum' => <float>, 'Minimum' => <float>, ], ], 'Scale' => [ 'Linear' => [ 'StepCount' => <integer>, 'StepSize' => <float>, ], 'Logarithmic' => [ 'Base' => <float>, ], ], ], ], 'GridLineVisibility' => 'HIDDEN|VISIBLE', 'ScrollbarOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', 'VisibleRange' => [ 'PercentRange' => [ 'From' => <float>, 'To' => <float>, ], ], ], 'TickLabelOptions' => [ 'LabelOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'RotationAngle' => <float>, ], ], 'PrimaryYAxisLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ReferenceLines' => [ [ 'DataConfiguration' => [ // REQUIRED 'AxisBinding' => 'PRIMARY_YAXIS|SECONDARY_YAXIS', 'DynamicConfiguration' => [ 'Calculation' => [ // REQUIRED 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'MeasureAggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], ], 'SeriesType' => 'BAR|LINE', 'StaticConfiguration' => [ 'Value' => <float>, // REQUIRED ], ], 'LabelConfiguration' => [ 'CustomLabelConfiguration' => [ 'CustomLabel' => '<string>', // REQUIRED ], 'FontColor' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'HorizontalPosition' => 'LEFT|CENTER|RIGHT', 'ValueLabelConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], 'RelativePosition' => 'BEFORE_CUSTOM_LABEL|AFTER_CUSTOM_LABEL', ], 'VerticalPosition' => 'ABOVE|BELOW', ], 'Status' => 'ENABLED|DISABLED', 'StyleConfiguration' => [ 'Color' => '<string>', 'Pattern' => 'SOLID|DASHED|DOTTED', ], ], // ... ], 'SortConfiguration' => [ 'CategorySort' => [ [ 'ColumnSort' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'FieldSort' => [ 'Direction' => 'ASC|DESC', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], ], // ... ], 'PaginationConfiguration' => [ 'PageNumber' => <integer>, // REQUIRED 'PageSize' => <integer>, // REQUIRED ], ], 'Tooltip' => [ 'FieldBasedTooltip' => [ 'AggregationVisibility' => 'HIDDEN|VISIBLE', 'TooltipFields' => [ [ 'ColumnTooltipItem' => [ 'Aggregation' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldTooltipItem' => [ 'FieldId' => '<string>', // REQUIRED 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'TooltipTitleType' => 'NONE|PRIMARY_VALUE', ], 'SelectedTooltipType' => 'BASIC|DETAILED', 'TooltipVisibility' => 'HIDDEN|VISIBLE', ], 'VisualPalette' => [ 'ChartColor' => '<string>', 'ColorMap' => [ [ 'Color' => '<string>', // REQUIRED 'Element' => [ // REQUIRED 'DataPathType' => [ 'PivotTableDataPathType' => 'HIERARCHY_ROWS_LAYOUT_COLUMN|MULTIPLE_ROW_METRICS_COLUMN|EMPTY_COLUMN_HEADER|COUNT_METRIC_COLUMN', ], 'FieldId' => '<string>', 'FieldValue' => '<string>', ], 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], ], ], 'ColumnHierarchies' => [ [ 'DateTimeHierarchy' => [ 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'ExplicitHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'PredefinedHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], ], // ... ], 'Subtitle' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'Title' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'VisualContentAltText' => '<string>', 'VisualId' => '<string>', // REQUIRED ], 'ComboChartVisual' => [ 'Actions' => [ [ 'ActionOperations' => [ // REQUIRED [ 'FilterOperation' => [ 'SelectedFieldsConfiguration' => [ // REQUIRED 'SelectedColumns' => [ [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'SelectedFieldOptions' => 'ALL_FIELDS', 'SelectedFields' => ['<string>', ...], ], 'TargetVisualsConfiguration' => [ // REQUIRED 'SameSheetTargetVisualConfiguration' => [ 'TargetVisualOptions' => 'ALL_VISUALS', 'TargetVisuals' => ['<string>', ...], ], ], ], 'NavigationOperation' => [ 'LocalNavigationConfiguration' => [ 'TargetSheetId' => '<string>', // REQUIRED ], ], 'SetParametersOperation' => [ 'ParameterValueConfigurations' => [ // REQUIRED [ 'DestinationParameterName' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'CustomValuesConfiguration' => [ 'CustomValues' => [ // REQUIRED 'DateTimeValues' => [<integer || string || DateTime>, ...], 'DecimalValues' => [<float>, ...], 'IntegerValues' => [<integer>, ...], 'StringValues' => ['<string>', ...], ], 'IncludeNullValue' => true || false, ], 'SelectAllValueOptions' => 'ALL_VALUES', 'SourceColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceField' => '<string>', 'SourceParameterName' => '<string>', ], ], // ... ], ], 'URLOperation' => [ 'URLTarget' => 'NEW_TAB|NEW_WINDOW|SAME_TAB', // REQUIRED 'URLTemplate' => '<string>', // REQUIRED ], ], // ... ], 'CustomActionId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'ENABLED|DISABLED', 'Trigger' => 'DATA_POINT_CLICK|DATA_POINT_MENU', // REQUIRED ], // ... ], 'ChartConfiguration' => [ 'BarDataLabels' => [ 'CategoryLabelVisibility' => 'HIDDEN|VISIBLE', 'DataLabelTypes' => [ [ 'DataPathLabelType' => [ 'FieldId' => '<string>', 'FieldValue' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldLabelType' => [ 'FieldId' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'MaximumLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'MinimumLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'RangeEndsLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'LabelColor' => '<string>', 'LabelContent' => 'VALUE|PERCENT|VALUE_AND_PERCENT', 'LabelFontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'MeasureLabelVisibility' => 'HIDDEN|VISIBLE', 'Overlap' => 'DISABLE_OVERLAP|ENABLE_OVERLAP', 'Position' => 'INSIDE|OUTSIDE|LEFT|TOP|BOTTOM|RIGHT', 'TotalsVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'BarsArrangement' => 'CLUSTERED|STACKED|STACKED_PERCENT', 'CategoryAxis' => [ 'AxisLineVisibility' => 'HIDDEN|VISIBLE', 'AxisOffset' => '<string>', 'DataOptions' => [ 'DateAxisOptions' => [ 'MissingDateVisibility' => 'HIDDEN|VISIBLE', ], 'NumericAxisOptions' => [ 'Range' => [ 'DataDriven' => [ ], 'MinMax' => [ 'Maximum' => <float>, 'Minimum' => <float>, ], ], 'Scale' => [ 'Linear' => [ 'StepCount' => <integer>, 'StepSize' => <float>, ], 'Logarithmic' => [ 'Base' => <float>, ], ], ], ], 'GridLineVisibility' => 'HIDDEN|VISIBLE', 'ScrollbarOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', 'VisibleRange' => [ 'PercentRange' => [ 'From' => <float>, 'To' => <float>, ], ], ], 'TickLabelOptions' => [ 'LabelOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'RotationAngle' => <float>, ], ], 'CategoryLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ColorLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldWells' => [ 'ComboChartAggregatedFieldWells' => [ 'BarValues' => [ [ 'CalculatedMeasureField' => [ 'Expression' => '<string>', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], 'CategoricalMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'DateMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'NumericalMeasureField' => [ 'AggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], ], // ... ], 'Category' => [ [ 'CategoricalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'DateDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DateGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'NumericalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], ], // ... ], 'Colors' => [ [ 'CategoricalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'DateDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DateGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'NumericalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], ], // ... ], 'LineValues' => [ [ 'CalculatedMeasureField' => [ 'Expression' => '<string>', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], 'CategoricalMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'DateMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'NumericalMeasureField' => [ 'AggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], ], // ... ], ], ], 'Interactions' => [ 'ContextMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], 'VisualMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], ], 'Legend' => [ 'Height' => '<string>', 'Position' => 'AUTO|RIGHT|BOTTOM|TOP', 'Title' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'ValueFontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', ], 'LineDataLabels' => [ 'CategoryLabelVisibility' => 'HIDDEN|VISIBLE', 'DataLabelTypes' => [ [ 'DataPathLabelType' => [ 'FieldId' => '<string>', 'FieldValue' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldLabelType' => [ 'FieldId' => '<string>', 'Visibility' => 'HIDDEN|VISIBLE', ], 'MaximumLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'MinimumLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], 'RangeEndsLabelType' => [ 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'LabelColor' => '<string>', 'LabelContent' => 'VALUE|PERCENT|VALUE_AND_PERCENT', 'LabelFontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'MeasureLabelVisibility' => 'HIDDEN|VISIBLE', 'Overlap' => 'DISABLE_OVERLAP|ENABLE_OVERLAP', 'Position' => 'INSIDE|OUTSIDE|LEFT|TOP|BOTTOM|RIGHT', 'TotalsVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'PrimaryYAxisDisplayOptions' => [ 'AxisLineVisibility' => 'HIDDEN|VISIBLE', 'AxisOffset' => '<string>', 'DataOptions' => [ 'DateAxisOptions' => [ 'MissingDateVisibility' => 'HIDDEN|VISIBLE', ], 'NumericAxisOptions' => [ 'Range' => [ 'DataDriven' => [ ], 'MinMax' => [ 'Maximum' => <float>, 'Minimum' => <float>, ], ], 'Scale' => [ 'Linear' => [ 'StepCount' => <integer>, 'StepSize' => <float>, ], 'Logarithmic' => [ 'Base' => <float>, ], ], ], ], 'GridLineVisibility' => 'HIDDEN|VISIBLE', 'ScrollbarOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', 'VisibleRange' => [ 'PercentRange' => [ 'From' => <float>, 'To' => <float>, ], ], ], 'TickLabelOptions' => [ 'LabelOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'RotationAngle' => <float>, ], ], 'PrimaryYAxisLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'ReferenceLines' => [ [ 'DataConfiguration' => [ // REQUIRED 'AxisBinding' => 'PRIMARY_YAXIS|SECONDARY_YAXIS', 'DynamicConfiguration' => [ 'Calculation' => [ // REQUIRED 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'MeasureAggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], ], 'SeriesType' => 'BAR|LINE', 'StaticConfiguration' => [ 'Value' => <float>, // REQUIRED ], ], 'LabelConfiguration' => [ 'CustomLabelConfiguration' => [ 'CustomLabel' => '<string>', // REQUIRED ], 'FontColor' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'HorizontalPosition' => 'LEFT|CENTER|RIGHT', 'ValueLabelConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], 'RelativePosition' => 'BEFORE_CUSTOM_LABEL|AFTER_CUSTOM_LABEL', ], 'VerticalPosition' => 'ABOVE|BELOW', ], 'Status' => 'ENABLED|DISABLED', 'StyleConfiguration' => [ 'Color' => '<string>', 'Pattern' => 'SOLID|DASHED|DOTTED', ], ], // ... ], 'SecondaryYAxisDisplayOptions' => [ 'AxisLineVisibility' => 'HIDDEN|VISIBLE', 'AxisOffset' => '<string>', 'DataOptions' => [ 'DateAxisOptions' => [ 'MissingDateVisibility' => 'HIDDEN|VISIBLE', ], 'NumericAxisOptions' => [ 'Range' => [ 'DataDriven' => [ ], 'MinMax' => [ 'Maximum' => <float>, 'Minimum' => <float>, ], ], 'Scale' => [ 'Linear' => [ 'StepCount' => <integer>, 'StepSize' => <float>, ], 'Logarithmic' => [ 'Base' => <float>, ], ], ], ], 'GridLineVisibility' => 'HIDDEN|VISIBLE', 'ScrollbarOptions' => [ 'Visibility' => 'HIDDEN|VISIBLE', 'VisibleRange' => [ 'PercentRange' => [ 'From' => <float>, 'To' => <float>, ], ], ], 'TickLabelOptions' => [ 'LabelOptions' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'RotationAngle' => <float>, ], ], 'SecondaryYAxisLabelOptions' => [ 'AxisLabelOptions' => [ [ 'ApplyTo' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED ], 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], ], // ... ], 'SortIconVisibility' => 'HIDDEN|VISIBLE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'SingleAxisOptions' => [ 'YAxisOptions' => [ 'YAxis' => 'PRIMARY_Y_AXIS', // REQUIRED ], ], 'SortConfiguration' => [ 'CategoryItemsLimit' => [ 'ItemsLimit' => <integer>, 'OtherCategories' => 'INCLUDE|EXCLUDE', ], 'CategorySort' => [ [ 'ColumnSort' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'FieldSort' => [ 'Direction' => 'ASC|DESC', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], ], // ... ], 'ColorItemsLimit' => [ 'ItemsLimit' => <integer>, 'OtherCategories' => 'INCLUDE|EXCLUDE', ], 'ColorSort' => [ [ 'ColumnSort' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'FieldSort' => [ 'Direction' => 'ASC|DESC', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], ], // ... ], ], 'Tooltip' => [ 'FieldBasedTooltip' => [ 'AggregationVisibility' => 'HIDDEN|VISIBLE', 'TooltipFields' => [ [ 'ColumnTooltipItem' => [ 'Aggregation' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldTooltipItem' => [ 'FieldId' => '<string>', // REQUIRED 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'TooltipTitleType' => 'NONE|PRIMARY_VALUE', ], 'SelectedTooltipType' => 'BASIC|DETAILED', 'TooltipVisibility' => 'HIDDEN|VISIBLE', ], 'VisualPalette' => [ 'ChartColor' => '<string>', 'ColorMap' => [ [ 'Color' => '<string>', // REQUIRED 'Element' => [ // REQUIRED 'DataPathType' => [ 'PivotTableDataPathType' => 'HIERARCHY_ROWS_LAYOUT_COLUMN|MULTIPLE_ROW_METRICS_COLUMN|EMPTY_COLUMN_HEADER|COUNT_METRIC_COLUMN', ], 'FieldId' => '<string>', 'FieldValue' => '<string>', ], 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', ], // ... ], ], ], 'ColumnHierarchies' => [ [ 'DateTimeHierarchy' => [ 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'ExplicitHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'PredefinedHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], ], // ... ], 'Subtitle' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'Title' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'VisualContentAltText' => '<string>', 'VisualId' => '<string>', // REQUIRED ], 'CustomContentVisual' => [ 'Actions' => [ [ 'ActionOperations' => [ // REQUIRED [ 'FilterOperation' => [ 'SelectedFieldsConfiguration' => [ // REQUIRED 'SelectedColumns' => [ [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'SelectedFieldOptions' => 'ALL_FIELDS', 'SelectedFields' => ['<string>', ...], ], 'TargetVisualsConfiguration' => [ // REQUIRED 'SameSheetTargetVisualConfiguration' => [ 'TargetVisualOptions' => 'ALL_VISUALS', 'TargetVisuals' => ['<string>', ...], ], ], ], 'NavigationOperation' => [ 'LocalNavigationConfiguration' => [ 'TargetSheetId' => '<string>', // REQUIRED ], ], 'SetParametersOperation' => [ 'ParameterValueConfigurations' => [ // REQUIRED [ 'DestinationParameterName' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'CustomValuesConfiguration' => [ 'CustomValues' => [ // REQUIRED 'DateTimeValues' => [<integer || string || DateTime>, ...], 'DecimalValues' => [<float>, ...], 'IntegerValues' => [<integer>, ...], 'StringValues' => ['<string>', ...], ], 'IncludeNullValue' => true || false, ], 'SelectAllValueOptions' => 'ALL_VALUES', 'SourceColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceField' => '<string>', 'SourceParameterName' => '<string>', ], ], // ... ], ], 'URLOperation' => [ 'URLTarget' => 'NEW_TAB|NEW_WINDOW|SAME_TAB', // REQUIRED 'URLTemplate' => '<string>', // REQUIRED ], ], // ... ], 'CustomActionId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'ENABLED|DISABLED', 'Trigger' => 'DATA_POINT_CLICK|DATA_POINT_MENU', // REQUIRED ], // ... ], 'ChartConfiguration' => [ 'ContentType' => 'IMAGE|OTHER_EMBEDDED_CONTENT', 'ContentUrl' => '<string>', 'ImageScaling' => 'FIT_TO_HEIGHT|FIT_TO_WIDTH|DO_NOT_SCALE|SCALE_TO_VISUAL', 'Interactions' => [ 'ContextMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], 'VisualMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], ], ], 'DataSetIdentifier' => '<string>', // REQUIRED 'Subtitle' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'Title' => [ 'FormatText' => [ 'PlainText' => '<string>', 'RichText' => '<string>', ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'VisualContentAltText' => '<string>', 'VisualId' => '<string>', // REQUIRED ], 'EmptyVisual' => [ 'Actions' => [ [ 'ActionOperations' => [ // REQUIRED [ 'FilterOperation' => [ 'SelectedFieldsConfiguration' => [ // REQUIRED 'SelectedColumns' => [ [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'SelectedFieldOptions' => 'ALL_FIELDS', 'SelectedFields' => ['<string>', ...], ], 'TargetVisualsConfiguration' => [ // REQUIRED 'SameSheetTargetVisualConfiguration' => [ 'TargetVisualOptions' => 'ALL_VISUALS', 'TargetVisuals' => ['<string>', ...], ], ], ], 'NavigationOperation' => [ 'LocalNavigationConfiguration' => [ 'TargetSheetId' => '<string>', // REQUIRED ], ], 'SetParametersOperation' => [ 'ParameterValueConfigurations' => [ // REQUIRED [ 'DestinationParameterName' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'CustomValuesConfiguration' => [ 'CustomValues' => [ // REQUIRED 'DateTimeValues' => [<integer || string || DateTime>, ...], 'DecimalValues' => [<float>, ...], 'IntegerValues' => [<integer>, ...], 'StringValues' => ['<string>', ...], ], 'IncludeNullValue' => true || false, ], 'SelectAllValueOptions' => 'ALL_VALUES', 'SourceColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceField' => '<string>', 'SourceParameterName' => '<string>', ], ], // ... ], ], 'URLOperation' => [ 'URLTarget' => 'NEW_TAB|NEW_WINDOW|SAME_TAB', // REQUIRED 'URLTemplate' => '<string>', // REQUIRED ], ], // ... ], 'CustomActionId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'ENABLED|DISABLED', 'Trigger' => 'DATA_POINT_CLICK|DATA_POINT_MENU', // REQUIRED ], // ... ], 'DataSetIdentifier' => '<string>', // REQUIRED 'VisualId' => '<string>', // REQUIRED ], 'FilledMapVisual' => [ 'Actions' => [ [ 'ActionOperations' => [ // REQUIRED [ 'FilterOperation' => [ 'SelectedFieldsConfiguration' => [ // REQUIRED 'SelectedColumns' => [ [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'SelectedFieldOptions' => 'ALL_FIELDS', 'SelectedFields' => ['<string>', ...], ], 'TargetVisualsConfiguration' => [ // REQUIRED 'SameSheetTargetVisualConfiguration' => [ 'TargetVisualOptions' => 'ALL_VISUALS', 'TargetVisuals' => ['<string>', ...], ], ], ], 'NavigationOperation' => [ 'LocalNavigationConfiguration' => [ 'TargetSheetId' => '<string>', // REQUIRED ], ], 'SetParametersOperation' => [ 'ParameterValueConfigurations' => [ // REQUIRED [ 'DestinationParameterName' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'CustomValuesConfiguration' => [ 'CustomValues' => [ // REQUIRED 'DateTimeValues' => [<integer || string || DateTime>, ...], 'DecimalValues' => [<float>, ...], 'IntegerValues' => [<integer>, ...], 'StringValues' => ['<string>', ...], ], 'IncludeNullValue' => true || false, ], 'SelectAllValueOptions' => 'ALL_VALUES', 'SourceColumn' => [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'SourceField' => '<string>', 'SourceParameterName' => '<string>', ], ], // ... ], ], 'URLOperation' => [ 'URLTarget' => 'NEW_TAB|NEW_WINDOW|SAME_TAB', // REQUIRED 'URLTemplate' => '<string>', // REQUIRED ], ], // ... ], 'CustomActionId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'ENABLED|DISABLED', 'Trigger' => 'DATA_POINT_CLICK|DATA_POINT_MENU', // REQUIRED ], // ... ], 'ChartConfiguration' => [ 'FieldWells' => [ 'FilledMapAggregatedFieldWells' => [ 'Geospatial' => [ [ 'CategoricalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'DateDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'DateGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], 'NumericalDimensionField' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], 'HierarchyId' => '<string>', ], ], // ... ], 'Values' => [ [ 'CalculatedMeasureField' => [ 'Expression' => '<string>', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], 'CategoricalMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'DateMeasureField' => [ 'AggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'DateTimeFormat' => '<string>', 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumericFormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], 'NumericalMeasureField' => [ 'AggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'FieldId' => '<string>', // REQUIRED 'FormatConfiguration' => [ 'FormatConfiguration' => [ 'CurrencyDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', 'Symbol' => '<string>', ], 'NumberDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'NumberScale' => 'NONE|AUTO|THOUSANDS|MILLIONS|BILLIONS|TRILLIONS', 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], 'PercentageDisplayFormatConfiguration' => [ 'DecimalPlacesConfiguration' => [ 'DecimalPlaces' => <integer>, // REQUIRED ], 'NegativeValueConfiguration' => [ 'DisplayMode' => 'POSITIVE|NEGATIVE', // REQUIRED ], 'NullValueFormatConfiguration' => [ 'NullString' => '<string>', // REQUIRED ], 'Prefix' => '<string>', 'SeparatorConfiguration' => [ 'DecimalSeparator' => 'COMMA|DOT|SPACE', 'ThousandsSeparator' => [ 'Symbol' => 'COMMA|DOT|SPACE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], 'Suffix' => '<string>', ], ], ], ], ], // ... ], ], ], 'Interactions' => [ 'ContextMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], 'VisualMenuOption' => [ 'AvailabilityStatus' => 'ENABLED|DISABLED', ], ], 'Legend' => [ 'Height' => '<string>', 'Position' => 'AUTO|RIGHT|BOTTOM|TOP', 'Title' => [ 'CustomLabel' => '<string>', 'FontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', ], 'ValueFontConfiguration' => [ 'FontColor' => '<string>', 'FontDecoration' => 'UNDERLINE|NONE', 'FontFamily' => '<string>', 'FontSize' => [ 'Absolute' => '<string>', 'Relative' => 'EXTRA_SMALL|SMALL|MEDIUM|LARGE|EXTRA_LARGE', ], 'FontStyle' => 'NORMAL|ITALIC', 'FontWeight' => [ 'Name' => 'NORMAL|BOLD', ], ], 'Visibility' => 'HIDDEN|VISIBLE', 'Width' => '<string>', ], 'MapStyleOptions' => [ 'BaseMapStyle' => 'LIGHT_GRAY|DARK_GRAY|STREET|IMAGERY', ], 'SortConfiguration' => [ 'CategorySort' => [ [ 'ColumnSort' => [ 'AggregationFunction' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Direction' => 'ASC|DESC', // REQUIRED 'SortBy' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'FieldSort' => [ 'Direction' => 'ASC|DESC', // REQUIRED 'FieldId' => '<string>', // REQUIRED ], ], // ... ], ], 'Tooltip' => [ 'FieldBasedTooltip' => [ 'AggregationVisibility' => 'HIDDEN|VISIBLE', 'TooltipFields' => [ [ 'ColumnTooltipItem' => [ 'Aggregation' => [ 'AttributeAggregationFunction' => [ 'SimpleAttributeAggregation' => 'UNIQUE_VALUE', 'ValueForMultipleValues' => '<string>', ], 'CategoricalAggregationFunction' => 'COUNT|DISTINCT_COUNT', 'DateAggregationFunction' => 'COUNT|DISTINCT_COUNT|MIN|MAX', 'NumericalAggregationFunction' => [ 'PercentileAggregation' => [ 'PercentileValue' => <float>, ], 'SimpleNumericalAggregation' => 'SUM|AVERAGE|MIN|MAX|COUNT|DISTINCT_COUNT|VAR|VARP|STDEV|STDEVP|MEDIAN', ], ], 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], 'FieldTooltipItem' => [ 'FieldId' => '<string>', // REQUIRED 'Label' => '<string>', 'TooltipTarget' => 'BOTH|BAR|LINE', 'Visibility' => 'HIDDEN|VISIBLE', ], ], // ... ], 'TooltipTitleType' => 'NONE|PRIMARY_VALUE', ], 'SelectedTooltipType' => 'BASIC|DETAILED', 'TooltipVisibility' => 'HIDDEN|VISIBLE', ], 'WindowOptions' => [ 'Bounds' => [ 'East' => <float>, // REQUIRED 'North' => <float>, // REQUIRED 'South' => <float>, // REQUIRED 'West' => <float>, // REQUIRED ], 'MapZoomMode' => 'AUTO|MANUAL', ], ], 'ColumnHierarchies' => [ [ 'DateTimeHierarchy' => [ 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'ExplicitHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'RangeMaximum' => <integer || string || DateTime>, // REQUIRED 'RangeMinimum' => <integer || string || DateTime>, // REQUIRED 'TimeGranularity' => 'YEAR|QUARTER|MONTH|WEEK|DAY|HOUR|MINUTE|SECOND|MILLISECOND', // REQUIRED ], ], // ... ], 'HierarchyId' => '<string>', // REQUIRED ], 'PredefinedHierarchy' => [ 'Columns' => [ // REQUIRED [ 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], // ... ], 'DrillDownFilters' => [ [ 'CategoryFilter' => [ 'CategoryValues' => ['<string>', ...], // REQUIRED 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], ], 'NumericEqualityFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ], 'Value' => <float>, // REQUIRED ], 'TimeRangeFilter' => [ 'Column' => [ // REQUIRED 'ColumnName' => '<string>', // REQUIRED 'DataSetIdentifier' => '<string>', // REQUIRED ],