getReportData
post
/ccadmin/v1/reports/{id}
Get Report Data. Returns the report data as a list of records from a given reportId and other report filtering criteria details . Records are represented as a map with property name and value. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of report.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Root Schema : getReportData_request
Type:
Show Source
object
-
chart(optional):
boolean
Return results in chart format
-
couponCodes(optional):
string
Coupon ids as comma separted string.
-
groupBy(optional):
string
Group values by 'day', 'month', etc.
-
locations(optional):
array locations
Array of object having various region IDs for shipping and billing location filters.
-
metric(optional):
string
Metric of the reporting module.
-
priceListGroups(optional):
string
Pricelist groups as comma separted string.
-
productIds(optional):
boolean
Products IDs for product filter.
-
promotionIds(optional):
string
Promotion ids as comma separted string.
-
promotionTypeId(optional):
string
Promotion type id
-
siteIds(optional):
array siteIds
List of site ids for site filter.
-
timeFrame(optional):
string
Time frame for the reporting graph.
-
transactionCurrency(optional):
string
currency for the reporting graph.
Example:
{
"metric":"orders",
"productIds":[
"xprod2103",
"xprod2056"
],
"locations":[
{
"regionIds":[
"CA-NU",
"CA-QC",
"AF-BDG",
"AF-BGL"
],
"type":"shipping"
},
{
"regionIds":[
"IN-AP",
"IN-AS",
"AL-DI",
"AL-DR"
],
"type":"billing"
}
],
"siteIds":[
"siteUS"
],
"timeFrame":"last30days"
}
Nested Schema : locations
Type:
array
Array of object having various region IDs for shipping and billing location filters.
Show Source
Nested Schema : items
Type:
Show Source
object
-
regionIds(optional):
array regionIds
Array having region IDs for shipping fiter.
-
type(optional):
string
Type can be shipping or billing.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getReportData_response
Type:
Show Source
object
-
items(optional):
array items
Report data for detailedOrderMetrics. Properties in the response are dynamically generated, will change depending upon the reportId.
Nested Schema : items
Type:
array
Report data for detailedOrderMetrics. Properties in the response are dynamically generated, will change depending upon the reportId.
Show Source
Nested Schema : items
Type:
Show Source
object
-
averageOrderGrossRevenue(optional):
string
The average value of the Gross Revenue obtained for the orders submitted.
-
averageOrderMarkdownDiscount(optional):
string
The average value of the Markdown Discounts applied to the orders submitted.
-
averageOrderPromotionalDiscount(optional):
string
The average value of the Promotional Discounts that were applied to the orders submitted.
-
averageOrderSize(optional):
string
The average number of items/units sold contained in the orders submitted.
-
averageOrderValue(optional):
string
The average value obtained for the orders submitted.
-
excludedTax(optional):
string
The value of the tax (if tax is exclusive) applied to the orders submitted.
-
fullListPrice(optional):
string
The total list price of items sold. Full List Price revenue excludes tax, shipping revenue and any promotional or markdown discounts applied to the order.
-
grossRevenue(optional):
string
The amount of revenue gained from items sold for orders submitted. Gross Revenue excludes tax, shipping revenue and any promotional discounts applied to the order. It is calculated using the price a customer paid, regardless of whether this was the full list price or sale price.
-
includedTax(optional):
string
The value of the tax (if tax is inclusive) applied to the orders submitted.
-
markdownDiscount(optional):
string
The value of the discounts applied to orders submitted as a result of items/units being sold at a markdown price. Promotional discounts are not included.
-
netRevenue(optional):
string
The total amount received as a result of orders submitted. Net Revenue consists of the Gross Revenue from your sales orders as well as shipping and tax revenue. Promotional discounts are then subtracted to provide this figure.
-
orders(optional):
string
The Number of Orders submitted (where a payment has been authorized/approved/successfully processed).
-
promotionalDiscount(optional):
string
The value of the promotional discounts applied to the orders submitted.
-
shipping(optional):
string
The value of the shipping charges applied to the orders submitted.
-
unitsSold(optional):
string
Number of Items/units sold in the orders submitted.
Example Response (application/json)
[
{
"includedTax":"",
"netRevenue":"",
"unitsSold":"",
"averageOrderValue":"",
"promotionalDiscount":"",
"averageOrderMarkdownDiscount":"",
"grossRevenue":"",
"markdownDiscount":"",
"averageOrderPromotionalDiscount":"",
"shipping":"",
"fullListPrice":"",
"excludedTax":"",
"averageOrderGrossRevenue":"",
"orders":"0",
"averageOrderSize":""
}
]
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|94028|emptyReportCacheParameters.|
|94027|getReportDataCacheFailed.|
|20213|errorListingPriceListGroups|
|94004|reportDataParseError.|
|20035|listHistoryProductsInternalError.|
|94003|Product filter transform error.|
|94069|Category Ids filter transform parsing error|
|20034|getListProductsInternalError.|
|94007|InvalidReportInput.|
|94064|Transaction currency filter transform error.|
|94063|Transaction currency filter parsing error.|
|94002|Location filter transform error.|
|94068|Category Ids filter parsing error|
|94001|Product filter parsing error.|
|94023|unconfiguredReportVaribaleError.|
|94000|Location filter parsing error.|
|94022|Failed to get OBIEE analysis.|
|94066|price list group filter transfrom error.|
|94021|Invalid OBIEE analysis.|
|94065|price list group filter parsing error.|
|20052|List colletions internal Error|
|94015|reportNotConfigured.|
|94014|Log off to OBIEE failed.|
|94019|chartDataNotSupported.|
|94018|reportDataNotSupported.|
|20185|invalidPriceListGroup|
|94073|Organization filter transform parsing error|
|94072|Organization filter parsing error|
|94013|getSessionFailed.|
|94012|getObieeDataFailed.|
|94034|Credential properties retrieval error.|
|94033|Credential properties not set error.|
|20205|invalidTransactionCurrency|
|94071|Category Types filter transform parsing error|
|94070|Category Types filter parsing error|
|30022|invalidSiteId|
|94074|Site Ids filter parsing error|
|94075|Site Ids filter transform parsing error|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code