REST API for Oracle Commerce Cloud December 2017

audienceUsage

get

/ccadmin/v1/audienceUsage/{id}

Audience Usage. Retrieve the list of Audience consumers. The items in the response will have the following fields: id, displayName, assetType, assetTypeDisplayName, description. Items may also have an optional additionalMetaData property.

Request

Supported Media Types

application/json

Query Parameters

fields: Type: string

This controls which fields are returned in the response body. The default is to include the top-level response fields and the Audience id, displayName, description, and enabled fields.
limit: Type: integer

This is the field to specify the number of records to be fetched per REST call.
offset: Type: integer

This field specifies the offset/starting index from which data is to be fetched.
q: Type: string

This field allows you to filter the results using SCIM filtering syntax. For example, q=displayName co "aud" or description co "aud"
sort: Type: string

This field specifies the sort order of the list to be fetched. You can sort on id, displayName, assetType, assetTypeDisplayName or description. The secondary sort field will always be assetTypeDisplayName except when sorting by that property. In that case, the secondary sort will be by displayName. The default value is displayName:asc
totalResults: Type: boolean

Indicates if the total results should be included in the response. Defaults to true

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : audienceUsage_response

Properties

items: Type: array items

Additional Properties Allowed:

The returned list of audience consumers.
limit: Type: integer

Maximum number of audience consumers to be fetched.
offset: Type: integer

The starting index of the returned audience consumers.
sort: Type: object sort

Additional Properties Allowed:

The sort used for the returned audience consumers.
totalResults: Type: integer

The total number of audience consumers that match the supplied filter.

Nested Schema : items

Type: array

The returned list of audience consumers.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: object

The sort used for the returned audience consumers.

Properties

order: Type: string

The sort order: either asc or desc.
property: Type: string

The property sorted on. Can be id, displayName, assetType, assetTypeDisplayName or description.

Nested Schema : items

Type: object

Properties

assetType: Type: string

Indicates the type of consumer. I.e. audience, experiment, slot, etc.
assetTypeDisplayName: Type: string

The user-friendly display name of the assetType.
description: Type: string

The audience consumer description.
displayName: Type: string

The audience consumer display name.
id: Type: string

The audience consumer ID.

Example application/json


{
    "totalResults":2,
    "offset":0,
    "limit":40,
    "items":[
        {
            "assetTypeDisplayName":"Audience",
            "displayName":"Audience 2",
            "description":"audience2 audience2 audience2",
            "id":"audience2",
            "assetType":"audience"
        },
        {
            "assetTypeDisplayName":"Slot",
            "displayName":"Slot 1",
            "description":"slot1 slot1 slot1",
            "id":"slot1",
            "additionalMetadata":{
                "layoutID":"layout1"
            },
            "assetType":"slot"
        }
    ]
}

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

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "totalResults": 2,
  "offset": 0,
  "limit": 40,
  "items": [
    {
      "assetTypeDisplayName": "Audience",
      "displayName": "Audience 2",
      "description": "audience2 audience2 audience2",
      "id": "audience2",
      "assetType": "audience"
    },
    {
      "assetTypeDisplayName": "Slot",
      "displayName": "Slot 1",
      "description": "slot1 slot1 slot1",
      "id": "slot1",
      "additionalMetadata": {"layoutID": "layout1"},
      "assetType": "slot"
    }
  ]
}