Get the items for a given recommendation
get
/resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items
The resource endpoint returns the aggregated results for a given recommendation asset
belonging to a given site name.
Important Note: It is a Collection Resource. All the recommended assets for the given recommendation name are available in an items array in the response. Each result is again an aggregated asset. So all the aggregate asset query params (assetDepth, expand, fields) are also applicable to this resource. These aggregate asset query params are applied to each result in the items array. To know more about aggregate asset query params, refer to Asset Resource end point.
Important Note: It is a Collection Resource. All the recommended assets for the given recommendation name are available in an items array in the response. Each result is again an aggregated asset. So all the aggregate asset query params (assetDepth, expand, fields) are also applicable to this resource. These aggregate asset query params are applied to each result in the items array. To know more about aggregate asset query params, refer to Asset Resource end point.
Request
Path Parameters
-
recommendationName: string
Name of the recommendation
-
siteName: string
Name of the site
Query Parameters
-
assetDepth: number
To know about this parameter, refer to the 'assetDepth' query param in Asset Resource end point. Applicable to each result in the items array.
-
expand: string
Accepts a comma-separated list of assetTypes. To know more about this parameter, refer to the 'expand' query param in Asset Resource end point. Applicable to each result in the items array.
-
fields: string
To know about this parameter, refer to the 'fields' query param in Asset Resource end point. Applicable to each result in the items array.
-
limit: number
Specify the total number of items to be returned.
-
links: string
Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).
-
offset: number
Specify the starting index from where the results will be returned.
-
profileName: string
SitesVisitorService profile name based on which recommendations are evaluated
-
segments: string
Accepts comma-separated segment names based on which recommendations are evaluated.
-
totalResults: boolean
Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.
-
visitorid: number
Visitor ID based on which recommendations are evaluated
Response
Supported Media Types
- application/json
200 Response
Recommendation asset results in aggregated format