Jump to

• Request
• Response

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(optional): 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(optional): integer
  This is the field to specify the number of records to be fetched per REST call.
• offset(optional): integer
  This field specifies the offset/starting index from which data is to be fetched.
• q(optional): string
  This field allows you to filter the results using SCIM filtering syntax. For example, q=displayName co "aud" or description co "aud"
• sort(optional): 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(optional): boolean
  Indicates if the total results should be included in the response. Defaults to true

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : audienceUsage_response

Type: object

Show Source

• items(optional): array items
  The returned list of audience consumers.
• limit(optional): integer
  Maximum number of audience consumers to be fetched.
• offset(optional): integer
  The starting index of the returned audience consumers.
• sort(optional): object sort
  The sort used for the returned audience consumers.
• totalResults(optional): integer
  The total number of audience consumers that match the supplied filter.

{
    "properties":{
        "totalResults":{
            "description":"The total number of audience consumers that match the supplied filter.",
            "type":"integer"
        },
        "offset":{
            "description":"The starting index of the returned audience consumers.",
            "type":"integer"
        },
        "limit":{
            "description":"Maximum number of audience consumers to be fetched.",
            "type":"integer"
        },
        "sort":{
            "description":"The sort used for the returned audience consumers.",
            "type":"object",
            "properties":{
                "property":{
                    "description":"The property sorted on.  Can be id, displayName, assetType, assetTypeDisplayName or description.",
                    "type":"string"
                },
                "order":{
                    "description":"The sort order: either asc or desc.",
                    "type":"string"
                }
            }
        },
        "items":{
            "description":"The returned list of audience consumers.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "assetTypeDisplayName":{
                        "description":"The user-friendly display name of the assetType.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The audience consumer display name.",
                        "type":"string"
                    },
                    "description":{
                        "description":"The audience consumer description.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The audience consumer ID.",
                        "type":"string"
                    },
                    "assetType":{
                        "description":"Indicates the type of consumer.  I.e. audience, experiment, slot, etc.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The returned list of audience consumers.

Show Source

• Array of: object items

{
    "description":"The returned list of audience consumers.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "assetTypeDisplayName":{
                "description":"The user-friendly display name of the assetType.",
                "type":"string"
            },
            "displayName":{
                "description":"The audience consumer display name.",
                "type":"string"
            },
            "description":{
                "description":"The audience consumer description.",
                "type":"string"
            },
            "id":{
                "description":"The audience consumer ID.",
                "type":"string"
            },
            "assetType":{
                "description":"Indicates the type of consumer.  I.e. audience, experiment, slot, etc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: object

The sort used for the returned audience consumers.

Show Source

• order(optional): string
  The sort order: either asc or desc.
• property(optional): string
  The property sorted on. Can be id, displayName, assetType, assetTypeDisplayName or description.

{
    "description":"The sort used for the returned audience consumers.",
    "type":"object",
    "properties":{
        "property":{
            "description":"The property sorted on.  Can be id, displayName, assetType, assetTypeDisplayName or description.",
            "type":"string"
        },
        "order":{
            "description":"The sort order: either asc or desc.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assetType(optional): string
  Indicates the type of consumer. I.e. audience, experiment, slot, etc.
• assetTypeDisplayName(optional): string
  The user-friendly display name of the assetType.
• description(optional): string
  The audience consumer description.
• displayName(optional): string
  The audience consumer display name.
• id(optional): string
  The audience consumer ID.

{
    "type":"object",
    "properties":{
        "assetTypeDisplayName":{
            "description":"The user-friendly display name of the assetType.",
            "type":"string"
        },
        "displayName":{
            "description":"The audience consumer display name.",
            "type":"string"
        },
        "description":{
            "description":"The audience consumer description.",
            "type":"string"
        },
        "id":{
            "description":"The audience consumer ID.",
            "type":"string"
        },
        "assetType":{
            "description":"Indicates the type of consumer.  I.e. audience, experiment, slot, etc.",
            "type":"string"
        }
    }
}

Example Response (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| |------------------|------------------| |54061|The q parameter contains an invalid operation.| |54000|Invalid user input.|

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