post https://personafinai.azurewebsites.net/v2/personalized/search/trending
The trending search API returns a ranked list of trending searches over the last 24h which has increased in popularity the most, and is relevant to the target users interests
Prerequisites
Before obtaining meaningful data from this API ensure that
- You have you API
apikey. Contact us to find out how to get access.- To personalise responses it is vital to capture an end user identifier as part of behaviour capture. Without such user ids, the api will be able to surface trending searches across your whole user-base, but will not be able to return personalised, relevant, searches.
Example Call
Querying the trending search API is as simple as making a call to the endpoint and including your apikey and a valid end user id.
Details of the request and response objects are given in Request/Response
{
"apikey": <your apikey>,
"max_results": 10,
"customer_enduser_id": <end user id>
}
curl -X 'POST' \
'https://personafinai.azurewebsites.net/v2/personalized/search/trending' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"apikey": <your apikey>,
"max_results": 10,
"customer_enduser_id": <end user id>
}'
The API will return a list of identifier values corresponding to search terms.
Request/Response
Request Object
The API request expects the following endpoint url and body parameters
POST https://personafinai.azurewebsites.net/v2/personalized/search/trending
| Field | Description |
|---|---|
| apikey string | Authentication key to use to retrieve data |
| maxresults _int | The number of results to return |
| customerenduser_id _string | Value used to identify user on target platform |
Response Object
The API will respond with an object containing the following
| Field | Description |
|---|---|
| updated datetime | Datetime that the dataset returned was last computed for the given user |
| dataPoints object | List of the trending items found |
| dataPoints.identifier string | A given term searched for |
| dataPoints.distribution float | The items rank score relative to the other items |
| dataPoints.count int | The volume of interactions found against the specific item |