Get a collection of Hint records
Get information about all Hint records on a customer account.
Hint records are personalised recommendations associated with a customer account. They represent suggested products, offers, or actions identified as relevant to the customer. For AI-ranked reward recommendations, use GET /customers/{customer_id}/reward-recommendations.
Path parameters
The unique ID of the customer.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Search record by name or a part of the name.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"recommendations": [
{
"recommendation_id": "8bed991c68a470e7aaeffbf048",
"name": "Health recommendation",
"brief_description": "Health recommendation for the customer",
"detailed_description": "Detail description of the recommendation",
"content": "<h4>Lorem ipsum dolor sit amet, consectetur adipiscing elit. <br><\\/h4><h5>Donec nisl libero, finibus malesuada finibus a, sollicitudin eget erat. <br><\\/h5><p>Duis vitae pharetra mauris, ID ornare urna. Ut in volutpat ipsum. Aliquam euismod nibh est. Ut maximus risus ID malesuada egestas. Nunc nunc erat, porta ID lectus at, semper pulvinar orci. Maecenas lobortis ex non euismod vulputate. Aliquam erat volutpat. Mauris mauris ligula, eleifend vitae lectus non, hendrerit pharetra leo. <br><\\/p><p><br><\\/p><ul><li>dsadsaddsadsad<\\/li><li>dasdsadsadsad<\\/li><li>dsadasdsadsa<br><\\/li><\\/ul><p><br><\\/p><p>Duis vitae pharetra mauris, ID ornare urna. Ut in volutpat ipsum. Aliquam euismod nibh est. Ut maximus risus ID malesuada egestas. Nunc nunc erat, porta ID lectus at, semper pulvinar orci. Maecenas lobortis ex non euismod vulputate. Aliquam erat volutpat. Mauris mauris ligula, eleifend vitae lectus non, hendrerit pharetra leo. <\\/p> -a\"",
"picture_urls": [
"https://<projectURL>/health_recommendations_pictures/img_health_recommendations_16"
],
"last_change": "2020-04-16 09:53:08",
"state": 1
}
],
"total_items": 1
}
}