List all Audience Attributes.
get
/content/management/api/v1.1/personalization/audienceAttributes
This resource returns a list of available audience attributes that can be filtered by the attribute's categoryId. You can control the number of items to be fetched, paginated and sorted. Refer to the query syntax description to see the limitations.
Request
Query Parameters
-
default(optional): string
Default search query expression.
-
fields(optional): string
This parameter is used to control the returned fields for a audience attribute. This parameter accepts a comma-separated list of field names or all. These fields will be returned for each property in the list. As all the field names are case-sensitive, users must provide the correct field names in the query. Each audience attribute has both standard fields (id, name, description and categoryId. When fields is specified as all (case-insensitive), all the standard and additional fields are returned. The standard fields are always returned in the response and cannot be filtered out. Users can only filter out the additional fields. This parameter is optional in the query and by default result shows only standard fields in the response. Any incorrect or invalid field name given in the query will result in an error.
Example: ?fields=all
This will return all standard fields and all additional fields for each audience attribute.
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
orderBy(optional): string
Order by results.Default Value:
name:asc
-
q(optional): string
This parameter accepts a query expression condition that matches the field values. Query conditions can be joined using AND operators and grouped with parentheses. The value of a query condition follows the format of {fieldName} {operator} "{fieldValue}". The only field names allowed are name and categoryId The only value allowed in the operator is eq (Equals).
Example:
https://{cecsdomain}/content/management/api/v1.1/personalization/properties?q=(categoryId eq "AWVF3H79KJ2312VB0")
Example:
https://{cecsdomain}/content/management/api/v1.1/personalization/properties?q=(name eq "Some property") -
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : AudienceAttributes
Type:
object
AudienceAttributes
Show Source
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object audienceAttributeInfo
Audience Attribute Information
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : audienceAttributeInfo
Type:
object
Audience Attribute Information
Show Source
-
apiName(optional):
string
The reference name of the Audience Attribute. This is the name that is used in API calls that invoke the recommendation. If no reference name is provided the server will generate one from the name field. The referene name should be unique in a category.
-
categoryId:
string
The id of the Category the property belongs to.
-
description(optional):
string
The description of the Audience Attribute.
-
id:
string
The id of the Audience Attribute. This is a required propety in the get response and ignored in post/put requests.
-
links(optional):
array links
Links
-
name:
string
The name of the Audience Attribute. It is a required property in the get response and cannot be empty in post/put request.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
400 Response
Bad request.
403 Response
Forbidden.
500 Response
Internal server error.