getReport
get
/ccagent/v1/agentReports/{id}
Get Report. Returns the data for displaying chart with order count and order value information with the id set as 'chartOrders'.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Report Id.
Query Parameters
-
endDate: string
End date in ISO format for displaying the data
-
priceGroupId: string
PriceListGroup Id
-
startDate: string
Start date in ISO format for displaying the data
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getReport_response
Type:
Show Source
object
-
orderCountData(optional):
array orderCountData
Data for orders created on each day between the start date and end date
-
orderValueData(optional):
array orderValueData
Data for value of orders created on each day between the start date and end date
Nested Schema : orderCountData
Type:
array
Data for orders created on each day between the start date and end date
Show Source
Nested Schema : orderValueData
Type:
array
Data for value of orders created on each day between the start date and end date
Show Source
Nested Schema : items
Type:
Show Source
object
-
count(optional):
integer
The number of orders created on the date
-
creationDate(optional):
string
Creation date of the order in ISO format.
Nested Schema : items
Type:
Show Source
object
-
count(optional):
number
The total value of all the orders created on the day
-
creationDate(optional):
string
Creation date of the order in ISO format.
Example Response (application/json)
{
"orderValueData":[
{
"count":0,
"creationDate":"2015-04-26T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-04-27T18:30:00.000Z"
},
{
"count":7701.98,
"creationDate":"2015-04-28T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-04-29T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-04-30T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-05-01T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-05-02T18:30:00.000Z"
}
],
"orderCountData":[
{
"count":0,
"creationDate":"2015-04-26T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-04-27T18:30:00.000Z"
},
{
"count":8,
"creationDate":"2015-04-28T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-04-29T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-04-30T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-05-01T18:30:00.000Z"
},
{
"count":0,
"creationDate":"2015-05-02T18:30:00.000Z"
}
],
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagent/v1/agentReports/chartOrders?startDate=2015-04-26T18%3A30%3A00.000Z&endDate=2015-05-03T18%3A30%3A00.000Z"
}
]
}
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|
|------------------|------------------|
|50001|Generic Internal Error|
|200125|Blank input parameters.|
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