Consumer Goods Cloud Real Time Reporting Developer Guide

Introduction
Exporting the KPIs from Hyperforce
Prerequisites
Configuring Integration Dimension Meta
Triggering the CSV Export Process
REST API Endpoints
Triggering CSV Exports
Checking Job Status
Committing CSV Export
Retrieving CSV Exports
Examples
CGCloud Namespace
Customizing Real Time Reporting (RTR) with APEX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Committing CSV Export

Use the Commit CSV Export API to commit a specific csvGuid and take the related CSV as a new baseline for future delta exports. This means after this commit, the next delta export contains only those records in the KPIs that have been either added, changed, or deleted from the previous committed state.

The current version of a metadata configuration is available in the response of Checking Job Status. For example: "metaVersion": 8. If the underlying RTR Report Configuration record in a Salesforce org changes, then the previous commit is no longer valid for a delta export. A full export is scheduled next time.

Resource
/services/apexrest/cgcloud/measures/export/{{csvguid}}/commit
Method
POST

Path Parameters

URL Parameter Sample Value Description
csvGuid 3b549543-d420-401a-b424-29c7f3c75713 Enter the csvGuid value of the scheduled CSV export. This value is received as a response to the API request sent to Triggering CSV Exports API.

Request Parameters

Parameter Mandatory Type Description
businessyear Yes Integer Enter the business year for which the CSV export must be triggered.
metaname Yes String Enter the Internal Name of the RTR Report Configuration.
salesorg Yes String Enter the Salesorg ID.

Sample Request Body

1{
2    "salesorg": "0001",
3    "metaname": "IntegrationExportPromotion",
4    "businessyear": 2024
5}

Sample Response Body

1{"csvGuid":"5a2cb107-bc1f-4995-a782-291ec3d62d55","commitdate":"Fri, 01 Aug 2025 13:02:28 GMT"}