1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Report Filter Configuration

listReportFilterConfigurations

get

/ccadmin/v1/reportFilterConfigurations

List Report Filter Configurations. Returns all the filter configurations for the last run report for the profile currently logged in. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
  • application/json
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listReportFilterConfigurations_response
Nested Schema : items
Type: array
The list of all Filter configurations for all the contexts available
Nested Schema : items
Type: object
Nested Schema : billingCountries
Type: array
BillingCountries with all regions selected in the filter option
Nested Schema : billingRegions
Type: array
BillingRegions Codes of the regions selected in the filter option
Nested Schema : products
Type: array
Products with ProductId in form of array
Nested Schema : shippingCountries
Type: array
ShippingCountries with all regions selected in the filter option
Nested Schema : shippingRegions
Type: array
ShippingRegions Codes of the regions selected in the filter option
Nested Schema : siteIds
Type: array
Sites with SiteId in form of array
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

[
    {
        "reportingStartDate":null,
        "transactionCurrency":"USD",
        "billingRegions":[
            "US-AB",
            "US-AL"
        ],
        "reportingEndDate":null,
        "groupBy":"day",
        "shippingCountries":[
            "AS"
        ],
        "timeFrame":"yesterday",
        "products":[
            {
                "productId":"Product_15CD",
                "productName":"Abbott and Costello Meet Frankenstein"
            },
            {
                "productId":"Product_19Cxy",
                "productName":"16 Candles"
            }
        ],
        "priceListGroups":[
            "UsDollar"
        ],
        "billingCountries":[
            "AS"
        ],
        "metric":"grossRevenue",
        "shippingRegions":[
            "US-AB",
            "US-AL"
        ],
        "context":"orders",
        "siteIds":[
            {
                "siteURL":"localhost:9080",
                "siteId":"siteUS",
                "siteName":"Commerce Cloud Site"
            },
            {
                "siteURL":"localhost:9080",
                "siteId":"100001",
                "siteName":"Site2 cloud commerce"
            }
        ]
    }
]
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| |------------------|------------------| |94046|If some exception is thrown while some repository exception.|
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

Examples

Sample Response Payload returned by endpoint:

[{
  "reportingStartDate": null,
  "transactionCurrency": "USD",
  "billingRegions": [
    "US-AB",
    "US-AL"
  ],
  "reportingEndDate": null,
  "groupBy": "day",
  "shippingCountries": ["AS"],
  "timeFrame": "yesterday",
  "products": [
    {
      "productId": "Product_15CD",
      "productName": "Abbott and Costello Meet Frankenstein"
    },
    {
      "productId": "Product_19Cxy",
      "productName": "16 Candles"
    }
  ],
  "priceListGroups": ["UsDollar"],
  "billingCountries": ["AS"],
  "metric": "grossRevenue",
  "shippingRegions": [
    "US-AB",
    "US-AL"
  ],
  "context": "orders",
  "siteIds": [
    {
      "siteURL": "localhost:9080",
      "siteId": "siteUS",
      "siteName": "Commerce Cloud Site"
    },
    {
      "siteURL": "localhost:9080",
      "siteId": "100001",
      "siteName": "Site2 cloud commerce"
    }
  ]
}]