customReportValues API
Preview Date: 2025-08-16. Production Date: 2025-09-20.
We now enable you to apply time offsets to versions data directly using the customReportValues API for comparative analysis.
Changes
To shift the timeline of reported values, you can now specify these optional parameters for the Version element in the customReportValues API:
- Offset: The value by which you want to shift the time in the version.
- Offset-strata: The granularity (year, quarter, month) for the time shift.
Business Benefits
This feature provides flexibility and enhances your reporting and integration experiences.
Examples
<tier type="ver"> <el id="2" /> <el id="3" offset="1" offset-strata="2" /> <!-- Co-ordinate with Version id=3 will be offset by 1 unit of time strata id=2. For example if time strata id=2 is quarters, then values of Version id=3 co-ordinates will be shown +1 quarter --> </tier>
What Do I Need to Do?
To shift the timeline for your versions in reports, you must specify the Offset and Offset-strata parameters in the Version element of the customReportValues API.
What Happens If I Do Nothing?
The API works as is. Specifying the new version parameters is optional, required only for comparative analysis purposes.