REST API for Oracle Commerce Cloud December 2017

listAudiences

get

/ccadmin/v1/audiences

List Audiences. This operation is used to get the collection of audiences from Oracle Commerce Cloud.

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 to be fetched.
q: Type: string

This field specifies the query used to limit Audiences.
sort: Type: string

This field specifies the sort order of the list to be fetched.
totalResults: Type: boolean

Indicates if the total results should be included in the response.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listAudiences_response

Properties

items: Type: array items

Additional Properties Allowed:

The returned list of items.
limit: Type: integer

Maximum number of audiences to be fetched.
offset: Type: integer

The starting index of the returned audiences.
sort: Type: object sort

Additional Properties Allowed:

The sort used for the returned audiences.
totalResults: Type: integer

The total number of audiences that match the supplied filter.

Nested Schema : items

Type: array

The returned list of items.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: object

The sort used for the returned audiences.

Properties

order: Type: string

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

The property sorted on.

Nested Schema : items

Type: object

Properties

deleted: Type: boolean

Indicates if this audience is deleted.
description: Type: string

The audience description.
displayName: Type: string

The audience display name.
enabled: Type: boolean

Indicates if this audience is enabled.
id: Type: string

The audience Id.
ruleSet: Type: object ruleSet

Additional Properties Allowed:

The audience rule set.
usage: Type: array usage

Additional Properties Allowed:

The array of audience consumers.
useInReports: Type: boolean

Indicates if this audience will be used in reporting.

Nested Schema : ruleSet

Type: object

The audience rule set.

Properties

operator: Type: string

The operator applied to all of the rules in the rule set.
rules: Type: array rules

Additional Properties Allowed:

The array of rules that are contained in the rule set.

Nested Schema : usage

Type: array

The array of audience consumers.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : rules

Type: array

The array of rules that are contained in the rule set.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

category: Type: string

The category of the property, i.e. the user profile.
operator: Type: string

The operator applied to the rule property.
property: Type: string

The property to be evaluated.
value: Type: string

The value used to compare against the property value to determine the rule result. Values can be strings, integers, doubles, floats, JSON objects or JSON arrays depending on the operator and how the property was described in the audienceRuleProperty endpoint.

Nested Schema : items

Type: object

Properties

assetType: Type: string

The consumer type. I.e. slots, experiments, etc.
assetTypeDisplayName: Type: string

The localized user-friendly label for the consumer type.
count: Type: integer

The number of consumers of this type that this audience has.

Example application/json


{
    "q":"displayName co \"aud\" or description co \"aud\"",
    "totalResults":2,
    "offset":0,
    "limit":40,
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "displayName":"Audience 1",
            "usage":[
                {
                    "assetTypeDisplayName":"Audiences",
                    "count":2,
                    "assetType":"audiences"
                },
                {
                    "assetTypeDisplayName":"Experiments",
                    "count":1,
                    "assetType":"experiments"
                },
                {
                    "assetTypeDisplayName":"Slots",
                    "count":3,
                    "assetType":"slots"
                }
            ],
            "ruleSet":{
                "rules":[
                    {
                        "property":"gender",
                        "category":"profile",
                        "value":"male",
                        "operator":"eq"
                    }
                ],
                "operator":"all"
            },
            "description":"blah blah blah",
            "id":"audience1"
        },
        {
            "displayName":"Audience 2",
            "usage":[
                {
                    "assetTypeDisplayName":"Audiences",
                    "count":2,
                    "assetType":"audiences"
                },
                {
                    "assetTypeDisplayName":"Promotions",
                    "count":1,
                    "assetType":"promotions"
                },
                {
                    "assetTypeDisplayName":"Slots",
                    "count":3,
                    "assetType":"slots"
                }
            ],
            "ruleSet":{
                "rules":[
                    {
                        "property":"shippingAddress.city",
                        "category":"profile",
                        "value":"San Francisco",
                        "operator":"eq"
                    }
                ],
                "operator":"all"
            },
            "description":"blah blah blah",
            "id":"audience2"
        }
    ]
}

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| |------------------|------------------| |54004|An error occurred accessing audiences with query {0}.| |85003|Invalid attribute in query: {}| |85000|q query param is not valid SCIM filter format|

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:

{
  "q": "displayName co \"aud\" or description co \"aud\"",
  "totalResults": 2,
  "offset": 0,
  "limit": 40,
  "sort": [{
    "property": "displayName",
    "order": "asc"
  }],
  "items": [
    {
      "displayName": "Audience 1",
      "usage": [
        {
          "assetTypeDisplayName": "Audiences",
          "count": 2,
          "assetType": "audiences"
        },
        {
          "assetTypeDisplayName": "Experiments",
          "count": 1,
          "assetType": "experiments"
        },
        {
          "assetTypeDisplayName": "Slots",
          "count": 3,
          "assetType": "slots"
        }
      ],
      "ruleSet": {
        "rules": [{
          "property": "gender",
          "category": "profile",
          "value": "male",
          "operator": "eq"
        }],
        "operator": "all"
      },
      "description": "blah blah blah",
      "id": "audience1"
    },
    {
      "displayName": "Audience 2",
      "usage": [
        {
          "assetTypeDisplayName": "Audiences",
          "count": 2,
          "assetType": "audiences"
        },
        {
          "assetTypeDisplayName": "Promotions",
          "count": 1,
          "assetType": "promotions"
        },
        {
          "assetTypeDisplayName": "Slots",
          "count": 3,
          "assetType": "slots"
        }
      ],
      "ruleSet": {
        "rules": [{
          "property": "shippingAddress.city",
          "category": "profile",
          "value": "San Francisco",
          "operator": "eq"
        }],
        "operator": "all"
      },
      "description": "blah blah blah",
      "id": "audience2"
    }
  ]
}