getDashboardReportConfigurations
get
/ccadmin/v1/dashboardReportConfigurations
Get Dashboard Report Configurations. Gets the configurations for all the dashboard reports including their chart configurations
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getDashboardReportConfigurations_response
Type:
Show Source
object
-
array(optional):
array array
Array of the report configurations.
Nested Schema : items
Type:
Show Source
object
-
chart(optional):
array chart
The chart configuration for this report
-
dateAxis(optional):
string
Date axis of the configured report.
-
defaultReport(optional):
boolean
Whether report is default.
-
detailedReport(optional):
object detailedReport
Detailed report for the report configurations.
-
displayName(optional):
string
Display name of the configured report.
-
name(optional):
string
Name of the configured report.
-
repositoryId(optional):
string
Repository ID of the configured report.
-
summaryInfoType(optional):
string
Summary information type of configured report.
-
summaryReport(optional):
object summaryReport
Summary report for the report configurations.
Nested Schema : detailedReport
Type:
object
Detailed report for the report configurations.
Show Source
-
repositoryId(optional):
string
Repository ID of the detailed report.
Nested Schema : summaryReport
Type:
object
Summary report for the report configurations.
Show Source
-
repositoryId(optional):
string
Repository ID of the summary report.
Nested Schema : items
Type:
Show Source
object
-
animationOnDataChange(optional):
string
Type of animation on data change, Set the attribute to 'auto' to enable data change animation.
-
animationOnDisplay(optional):
string
Type of animation display provided, Set the attribute to 'auto' to enable initial display animation.
-
component(optional):
string
Component type of chart, e.g. ojchart.
-
dataCursor(optional):
string
Whether dataCursor feature is enabled. Set this attribute to 'on' to enable the data cursor.
-
hideAndShowBehavior(optional):
string
Whether hideAndShowBehavior of chart is enabled. By default this feature is disabled. It's values can be 'none', 'withRescale', or 'withoutRescale'.
-
hoverBehavior(optional):
string
Whether hoverBehavior of chart is enabled.
-
id(optional):
string
ID of the chart.
-
orientation(optional):
string
Orientation of the chart, vertical or horizontal.
-
overview(optional):
string
Whether overview of chart provided.
-
stack(optional):
string
Whether stack is provided for chart.
-
timeAxisType(optional):
boolean
Whether timeAxisType of chart is enabled. It can be of two types, 'regular' or 'mixed frequency'.
-
type(optional):
string
Type of chart, e.g. line, bar, pie, etc.
-
zoomAndScroll(optional):
string
Whether zoomAndScroll feature is enabled. We can set this attribute to either 'live', 'liveScrollOnly' (to disable zoom), or 'off' (to disable both zoom and scroll).
Example Response (application/json)
[
{
"fullReportsTabId":"orders",
"summaryReport":{
"repositoryId":"orderMetrics"
},
"detailedReport":{
"repositoryId":"detailedOrderMetrics"
},
"defaultReport":true,
"displayName":"Gross Revenue",
"name":"grossRevenue",
"repositoryId":"grossRevenue",
"summaryInfoType":"currency",
"chart":{
"overview":"off",
"animationOnDisplay":"auto",
"orientation":"vertical",
"stack":"off",
"hoverBehavior":"dim",
"type":"area",
"animationOnDataChange":"auto",
"zoomAndScroll":"off",
"component":"ojChart",
"hideAndShowBehavior":"off",
"repositoryId":"simpleLine",
"timeAxisType":"disabled",
"dataCursor":"off"
},
"dateAxis":"groups"
},
{
"fullReportsTabId":"orders",
"summaryReport":{
"repositoryId":"orderMetrics"
},
"detailedReport":{
"repositoryId":"detailedOrderMetrics"
},
"defaultReport":false,
"displayName":"Orders",
"name":"orders",
"repositoryId":"orders",
"summaryInfoType":"numeric",
"chart":{
"overview":"off",
"animationOnDisplay":"auto",
"orientation":"vertical",
"stack":"off",
"hoverBehavior":"dim",
"type":"area",
"animationOnDataChange":"auto",
"zoomAndScroll":"off",
"component":"ojChart",
"hideAndShowBehavior":"off",
"repositoryId":"simpleLine",
"timeAxisType":"disabled",
"dataCursor":"off"
},
"dateAxis":"groups"
},
{
"fullReportsTabId":"trafficVolume",
"summaryReport":{
"repositoryId":"trafficVolumeSummary"
},
"detailedReport":{
"repositoryId":"trafficVolumeDetail"
},
"defaultReport":false,
"displayName":"Site Traffic",
"name":"visits",
"repositoryId":"visits",
"summaryInfoType":"numeric",
"chart":{
"overview":"off",
"animationOnDisplay":"auto",
"orientation":"vertical",
"stack":"off",
"hoverBehavior":"dim",
"type":"area",
"animationOnDataChange":"auto",
"zoomAndScroll":"off",
"component":"ojChart",
"hideAndShowBehavior":"off",
"repositoryId":"simpleLine",
"timeAxisType":"disabled",
"dataCursor":"off"
},
"dateAxis":"groups"
}
]
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|
|------------------|------------------|
|94020|List report configuration error.|
|94011|Error in fetching summary in dashboard.|
|94010|Error in fetching report configuration in dashboard.|
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