Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getDashboardReportConfigurations_response

Type: object

Show Source

• array(optional): array array
  Array of the report configurations.

{
    "properties":{
        "array":{
            "description":"Array of the report configurations.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "summaryReport":{
                        "description":"Summary report for the report configurations.",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID of the summary report.",
                                "type":"string"
                            }
                        }
                    },
                    "detailedReport":{
                        "description":"Detailed report for the report configurations.",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID of the detailed report.",
                                "type":"string"
                            }
                        }
                    },
                    "defaultReport":{
                        "description":"Whether report is default.",
                        "type":"boolean"
                    },
                    "displayName":{
                        "description":"Display name of the configured report.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the configured report.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository ID of the configured report.",
                        "type":"string"
                    },
                    "summaryInfoType":{
                        "description":"Summary information type of configured report.",
                        "type":"string"
                    },
                    "chart":{
                        "description":"The chart configuration for this report",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "overview":{
                                    "description":"Whether overview of chart provided.",
                                    "type":"string"
                                },
                                "animationOnDisplay":{
                                    "description":"Type of animation display provided, Set the attribute to 'auto' to enable initial display animation.",
                                    "type":"string"
                                },
                                "orientation":{
                                    "description":"Orientation of the chart, vertical or horizontal.",
                                    "type":"string"
                                },
                                "stack":{
                                    "description":"Whether stack is provided for chart.",
                                    "type":"string"
                                },
                                "hoverBehavior":{
                                    "description":"Whether hoverBehavior of chart is enabled.",
                                    "type":"string"
                                },
                                "animationOnDataChange":{
                                    "description":"Type of animation on data change, Set the attribute to 'auto' to enable data change animation.",
                                    "type":"string"
                                },
                                "type":{
                                    "description":"Type of chart, e.g. line, bar, pie, etc.",
                                    "type":"string"
                                },
                                "zoomAndScroll":{
                                    "description":"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). ",
                                    "type":"string"
                                },
                                "component":{
                                    "description":"Component type of chart, e.g. ojchart.",
                                    "type":"string"
                                },
                                "hideAndShowBehavior":{
                                    "description":"Whether hideAndShowBehavior of chart is enabled. By default this feature is disabled. It's values can be 'none', 'withRescale', or 'withoutRescale'.",
                                    "type":"string"
                                },
                                "timeAxisType":{
                                    "description":"Whether timeAxisType of chart is enabled. It can be of two types, 'regular' or 'mixed frequency'.",
                                    "type":"boolean"
                                },
                                "id":{
                                    "description":"ID of the chart.",
                                    "type":"string"
                                },
                                "dataCursor":{
                                    "description":"Whether dataCursor feature is enabled. Set this attribute to 'on' to enable the data cursor.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "dateAxis":{
                        "description":"Date axis of the configured report.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : array

Type: array

Array of the report configurations.

Show Source

• Array of: object items

{
    "description":"Array of the report configurations.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "summaryReport":{
                "description":"Summary report for the report configurations.",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of the summary report.",
                        "type":"string"
                    }
                }
            },
            "detailedReport":{
                "description":"Detailed report for the report configurations.",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of the detailed report.",
                        "type":"string"
                    }
                }
            },
            "defaultReport":{
                "description":"Whether report is default.",
                "type":"boolean"
            },
            "displayName":{
                "description":"Display name of the configured report.",
                "type":"string"
            },
            "name":{
                "description":"Name of the configured report.",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository ID of the configured report.",
                "type":"string"
            },
            "summaryInfoType":{
                "description":"Summary information type of configured report.",
                "type":"string"
            },
            "chart":{
                "description":"The chart configuration for this report",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "overview":{
                            "description":"Whether overview of chart provided.",
                            "type":"string"
                        },
                        "animationOnDisplay":{
                            "description":"Type of animation display provided, Set the attribute to 'auto' to enable initial display animation.",
                            "type":"string"
                        },
                        "orientation":{
                            "description":"Orientation of the chart, vertical or horizontal.",
                            "type":"string"
                        },
                        "stack":{
                            "description":"Whether stack is provided for chart.",
                            "type":"string"
                        },
                        "hoverBehavior":{
                            "description":"Whether hoverBehavior of chart is enabled.",
                            "type":"string"
                        },
                        "animationOnDataChange":{
                            "description":"Type of animation on data change, Set the attribute to 'auto' to enable data change animation.",
                            "type":"string"
                        },
                        "type":{
                            "description":"Type of chart, e.g. line, bar, pie, etc.",
                            "type":"string"
                        },
                        "zoomAndScroll":{
                            "description":"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). ",
                            "type":"string"
                        },
                        "component":{
                            "description":"Component type of chart, e.g. ojchart.",
                            "type":"string"
                        },
                        "hideAndShowBehavior":{
                            "description":"Whether hideAndShowBehavior of chart is enabled. By default this feature is disabled. It's values can be 'none', 'withRescale', or 'withoutRescale'.",
                            "type":"string"
                        },
                        "timeAxisType":{
                            "description":"Whether timeAxisType of chart is enabled. It can be of two types, 'regular' or 'mixed frequency'.",
                            "type":"boolean"
                        },
                        "id":{
                            "description":"ID of the chart.",
                            "type":"string"
                        },
                        "dataCursor":{
                            "description":"Whether dataCursor feature is enabled. Set this attribute to 'on' to enable the data cursor.",
                            "type":"string"
                        }
                    }
                }
            },
            "dateAxis":{
                "description":"Date axis of the configured report.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "summaryReport":{
            "description":"Summary report for the report configurations.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID of the summary report.",
                    "type":"string"
                }
            }
        },
        "detailedReport":{
            "description":"Detailed report for the report configurations.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID of the detailed report.",
                    "type":"string"
                }
            }
        },
        "defaultReport":{
            "description":"Whether report is default.",
            "type":"boolean"
        },
        "displayName":{
            "description":"Display name of the configured report.",
            "type":"string"
        },
        "name":{
            "description":"Name of the configured report.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the configured report.",
            "type":"string"
        },
        "summaryInfoType":{
            "description":"Summary information type of configured report.",
            "type":"string"
        },
        "chart":{
            "description":"The chart configuration for this report",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "overview":{
                        "description":"Whether overview of chart provided.",
                        "type":"string"
                    },
                    "animationOnDisplay":{
                        "description":"Type of animation display provided, Set the attribute to 'auto' to enable initial display animation.",
                        "type":"string"
                    },
                    "orientation":{
                        "description":"Orientation of the chart, vertical or horizontal.",
                        "type":"string"
                    },
                    "stack":{
                        "description":"Whether stack is provided for chart.",
                        "type":"string"
                    },
                    "hoverBehavior":{
                        "description":"Whether hoverBehavior of chart is enabled.",
                        "type":"string"
                    },
                    "animationOnDataChange":{
                        "description":"Type of animation on data change, Set the attribute to 'auto' to enable data change animation.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Type of chart, e.g. line, bar, pie, etc.",
                        "type":"string"
                    },
                    "zoomAndScroll":{
                        "description":"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). ",
                        "type":"string"
                    },
                    "component":{
                        "description":"Component type of chart, e.g. ojchart.",
                        "type":"string"
                    },
                    "hideAndShowBehavior":{
                        "description":"Whether hideAndShowBehavior of chart is enabled. By default this feature is disabled. It's values can be 'none', 'withRescale', or 'withoutRescale'.",
                        "type":"string"
                    },
                    "timeAxisType":{
                        "description":"Whether timeAxisType of chart is enabled. It can be of two types, 'regular' or 'mixed frequency'.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of the chart.",
                        "type":"string"
                    },
                    "dataCursor":{
                        "description":"Whether dataCursor feature is enabled. Set this attribute to 'on' to enable the data cursor.",
                        "type":"string"
                    }
                }
            }
        },
        "dateAxis":{
            "description":"Date axis of the configured report.",
            "type":"string"
        }
    }
}

Nested Schema : chart

Type: array

The chart configuration for this report

Show Source

• Array of: object items

{
    "description":"The chart configuration for this report",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "overview":{
                "description":"Whether overview of chart provided.",
                "type":"string"
            },
            "animationOnDisplay":{
                "description":"Type of animation display provided, Set the attribute to 'auto' to enable initial display animation.",
                "type":"string"
            },
            "orientation":{
                "description":"Orientation of the chart, vertical or horizontal.",
                "type":"string"
            },
            "stack":{
                "description":"Whether stack is provided for chart.",
                "type":"string"
            },
            "hoverBehavior":{
                "description":"Whether hoverBehavior of chart is enabled.",
                "type":"string"
            },
            "animationOnDataChange":{
                "description":"Type of animation on data change, Set the attribute to 'auto' to enable data change animation.",
                "type":"string"
            },
            "type":{
                "description":"Type of chart, e.g. line, bar, pie, etc.",
                "type":"string"
            },
            "zoomAndScroll":{
                "description":"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). ",
                "type":"string"
            },
            "component":{
                "description":"Component type of chart, e.g. ojchart.",
                "type":"string"
            },
            "hideAndShowBehavior":{
                "description":"Whether hideAndShowBehavior of chart is enabled. By default this feature is disabled. It's values can be 'none', 'withRescale', or 'withoutRescale'.",
                "type":"string"
            },
            "timeAxisType":{
                "description":"Whether timeAxisType of chart is enabled. It can be of two types, 'regular' or 'mixed frequency'.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of the chart.",
                "type":"string"
            },
            "dataCursor":{
                "description":"Whether dataCursor feature is enabled. Set this attribute to 'on' to enable the data cursor.",
                "type":"string"
            }
        }
    }
}

Nested Schema : detailedReport

Type: object

Detailed report for the report configurations.

Show Source

• repositoryId(optional): string
  Repository ID of the detailed report.

{
    "description":"Detailed report for the report configurations.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the detailed report.",
            "type":"string"
        }
    }
}

Nested Schema : summaryReport

Type: object

Summary report for the report configurations.

Show Source

• repositoryId(optional): string
  Repository ID of the summary report.

{
    "description":"Summary report for the report configurations.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the summary report.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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).

{
    "type":"object",
    "properties":{
        "overview":{
            "description":"Whether overview of chart provided.",
            "type":"string"
        },
        "animationOnDisplay":{
            "description":"Type of animation display provided, Set the attribute to 'auto' to enable initial display animation.",
            "type":"string"
        },
        "orientation":{
            "description":"Orientation of the chart, vertical or horizontal.",
            "type":"string"
        },
        "stack":{
            "description":"Whether stack is provided for chart.",
            "type":"string"
        },
        "hoverBehavior":{
            "description":"Whether hoverBehavior of chart is enabled.",
            "type":"string"
        },
        "animationOnDataChange":{
            "description":"Type of animation on data change, Set the attribute to 'auto' to enable data change animation.",
            "type":"string"
        },
        "type":{
            "description":"Type of chart, e.g. line, bar, pie, etc.",
            "type":"string"
        },
        "zoomAndScroll":{
            "description":"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). ",
            "type":"string"
        },
        "component":{
            "description":"Component type of chart, e.g. ojchart.",
            "type":"string"
        },
        "hideAndShowBehavior":{
            "description":"Whether hideAndShowBehavior of chart is enabled. By default this feature is disabled. It's values can be 'none', 'withRescale', or 'withoutRescale'.",
            "type":"string"
        },
        "timeAxisType":{
            "description":"Whether timeAxisType of chart is enabled. It can be of two types, 'regular' or 'mixed frequency'.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of the chart.",
            "type":"string"
        },
        "dataCursor":{
            "description":"Whether dataCursor feature is enabled. Set this attribute to 'on' to enable the data cursor.",
            "type":"string"
        }
    }
}

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.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top