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

Checking Job Status

Use the CSV Export Job Status API to get the status of the scheduled export. The API uses the csvGuid of the scheduled export as an input parameter.

The job status can have one of the following values:

  • Queued
  • InProgress
  • Ready
  • Error
  • Aborted
Resource
/services/apexrest/cgcloud/measures/export/<csvguid>/status?salesorg=<salesorgvalue>
Method
GET

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.

Query Parameters

URL Parameter Type Description
salesorg String Enter the Salesorg name.

Sample Response Body for Queued Status

1{
2"Status":"Queued",
3"RequestDate":"2025-08-01T12:55:56.000Z",
4"MetaName":"IntegrationExportPromotion",
5"BusinessYear":2025,
6"Statistics":null
7}

Sample Response Body for Ready Status

1{
2"Status":"Ready",
3"RequestDate":"2025-08-01T12:55:56.000Z",
4"MetaName":"IntegrationExportPromotion",
5"BusinessYear":2025,
6"Statistics":
7{
8"csvGuid":"5a2cb107-bc1f-4995-a782-291ec3d62d55",
9"jobStartTime":"Fri, 01 Aug 2025 12:56:47 GMT",
10"hasDelta":false,
11"deltaToCsvGuid":null,
12"metaName":"IntegrationExportPromotion",
13"metaVersion":1,
14"totalAccounts":131,
15"totalCategories":6,
16"dimDataRetrievalDuration":480,
17"numRecords":1908,"numAccountCategoryKeys":786,
18"runDuration":31262,"processedAccountCategories":786,
19"jobCompletionTime":"Fri, 01 Aug 2025 12:57:19 GMT",
20"jobDuration":31975},
21"FullExport":"full/5a2cb107-bc1f-4995-a782-291ec3d62d55.csv.gz",
22"DeltaExport":"delta/5a2cb107-bc1f-4995-a782-291ec3d62d55.csv.gz"
23}