1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Reports

exportReportData

get

/ccadmin/v1/reports/export

Export Report Data. Export report data as a csv file. There is no json response for this request. The browser will download the csv file directly from the server. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
  • application/json
Query Parameters
billingCountry
Type: string
Billing country ids as comma separated string.
billingRegions
Type: string
Billing region ids as comma separated string.
categoryTypes
Type: string
Category Types for the deleted, unassigned, allcollection are sent as comma separated string.
cateogryIds
Type: string
Category ids as comma separated string.
couponCodes
Type: string
Coupon ids as comma separted string.
endDate
Type: string
End date of the custom time frame.
format
Type: string
Required: true
Format of the report. Default is CSV
groupBy
Type: string
Group by information for the report.
metric
Type: string
Metric selected if any.
priceListGroups
Type: string
Pricelist groups as comma separted string.
productIds
Type: string
Product ids as comma separted string.
promotionIds
Type: string
Promotion ids as comma separted string.
promotionTypeId
Type: string
Promotion type id
reportId
Type: string
Required: true
Report Id of the report to be downloaded.
shippingCountry
Type: string
Shipping country ids as comma separated string.
shippingRegions
Type: string
Shipping region ids as comma separated string.
siteIds
Type: string
Site ids as comma separated string.
startDate
Type: string
Start date of the custom time frame.
timeFrame
Type: string
Required: true
Time frame selected for the report.
timeZoneOffset
Type: string
Required: true
Offset in minutes between the client time zone and UTC time.
transactionCurrency
Type: string
currency for the reporting graph.
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request

Response

Supported Media Types
  • */*
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : exportReportData_response
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.| |94039|invalidParamValue.| |94027|getReportDataCacheFailed.| |94015|reportNotConfigured.| |94003|Product filter transform error.| |94014|Log off to OBIEE failed.| |94007|InvalidReportInput.| |94018|reportDataNotSupported.| |94064|Transaction currency filter transform error.| |94063|Transaction currency filter parsing error.| |94040|fileWriteOperationFailed.| |94002|Location filter transform error.| |94013|getSessionFailed.| |94001|Product filter parsing error.| |94012|getObieeDataFailed.| |94023|unconfiguredReportVaribaleError.| |94000|Location filter parsing error.| |94066|price list group filter transfrom error.| |94065|price list group filter parsing error.| |94074|Site Ids filter parsing error| |94075|Site Ids filter transform parsing error.|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object