Rollup Mode for Custom Expansions in customReportValues API
Preview Date: 2025-06-13. Production Date: 2025-06-13.
We add a new rollup mode, 'X' to the custom expansion states within the customReportValues API. This new rollup mode enables you to specify the parent nodes within a dimension value that you want to expand to display immediate descendants and their associated data.
Changes
In customReportValues API, you will now see a new option, 'X', available in the rollup mode attribute. Selecting rollup mode 'X' enables the start-Expanded property, allowing you to specify the initial node(s) for hierarchy expansion.
Example: Your hierarchical structure includes:
- HQ with an ID of 1.
- Engineering with an ID of 2.
Business Benefits
- Provides greater control over how your data is presented in reports and analytics.
- Simplifies the process of configuring specific hierarchical expansions. Previously you could achieve this only using Matrix reports.
- Eliminates the need to create multiple separate elements using a different rollup mode ('C') to replicate this behavior.
- Saves you time and streamlines your report definitions.
What Do I Need to Do?
For parent dimensions that you want to display as expanded, you must:
- Select the X option for the rollup-mode attribute.
- Specify the IDs in the start-Expanded property.
What Happens If I Do Nothing?
There's no change to existing behavior. You won't be able use the custom expansion feature for rollup-mode.