Get trending items
search
ACL
This method isn't available in the PHP API client
We released a new version of the PHP API client in public beta. Read the beta documentation for more information.
We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.
We released a new version of the Java API client in public beta. Read the beta documentation for more information.
You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
About this method
Retrieve global trending items.
Retrieve trending items for a specific facet if ‘facetName’ and ‘facetValue’ are passed. This method is only available in the JavaScript API client.
Examples
Read the Algolia CLI documentation for more information.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
client.getTrendingItems([
{
indexName: 'your_index_name',
threshold: 80,
facetName: 'category',
facetValue: 'sweaters'
},
])
.then(({ results }) => {
console.log(results);
})
.catch(err => {
console.log(err);
});
Parameters
| Parameter | Description |
|---|---|
requests
|
type: list of request object
Required
A list of request objects to execute. |
requests âž” request object
| Parameter | Description |
|---|---|
indexName
|
type: string
Required
The name of the target index. |
threshold
|
type: number
Optional
Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned. |
maxRecommendations
|
type: number
Optional
The number of recommendations to retrieve. Depending on the available recommendations and the other request parameters, the actual number of hits may be lower than that.
If |
facetName
|
type: string
Optional
The facet attribute to get recommendations for. |
facetValue
|
type: string
Optional
The facet value to get recommendations for. |
queryParameters
|
type: Omit<SearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>
Optional
List of search parameters to filter the recommendations. |
fallbackParameters
|
type: Omit<SearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>
Optional
List of search parameters to use as fallback when there are no recommendations. |
Response
This section shows the JSON response returned by the API.
Each API client encapsulates this response inside objects specific to the programming language,
so that the actual response might be different.
You can view the response by using the getLogs method.
Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.
JSON format
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"results": [
{
"hits": [
{
"_highlightResult": {
"category": {
"matchLevel": "none",
"matchedWords": [],
"value": "Men - T-Shirts"
},
"image_link": {
"matchLevel": "none",
"matchedWords": [],
"value": "https://example.org/image/D05927-8161-111-F01.jpg"
},
"name": {
"matchLevel": "none",
"matchedWords": [],
"value": "Jirgi Half-Zip T-Shirt"
}
},
"_score": 32.72,
"category": "Men - T-Shirts",
"image_link": "https://example.org/image/D05927-8161-111-F01.jpg",
"name": "Jirgi Half-Zip T-Shirt",
"objectID": "D05927-8161-111",
"position": 105,
"url": "men/t-shirts/d05927-8161-111"
}
],
"processingTimeMS": 1,
}
]
}
| Field | Description |
|---|---|
results
|
list of result
List of results in the order they were submitted, one per query. {
"results": [
{
"hits": [
{
...,
_score: 32.72
}
],
},
]
}
|
results âž” result
The results object contains the same hits object as the one of the search method. Each result also includes the following additional field:
| Field | Description |
|---|---|
_score
|
number
The confidence score of the recommended item, the closer it’s to 100, the more relevant. |
