Viewed Filters
settings
ACL
About this method
You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
Send a view event to capture the filters a user uses when viewing.
Examples
1
2
3
4
5
6
7
8
9
10
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
'YourApplicationID',
'YourSearchOnlyAPIKey'
);
$insights->user("user-1")->viewedFilters(
'your_event_name',
'your_index_name',
['brand:google']
);
Parameters
userToken
|
type: string
Required
A user identifier. Format: alpha numeric string [a-zA-Z0-9_-] Length: between 1 and 64 characters. |
eventName
|
type: string
Required
Name of the event. It’s best to follow the event naming guidelines. Format: any ASCII character except control characters. Length: between 1 and 64 characters. |
indexName
|
type: string
Required
Name of the index related to the view. |
filters
|
type: string[]
Required
A list of Format: Limited to 10 filters. |
Response
No response