Clicked filters
search
ACL
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
Send a click event to capture when users select filters.
Use this event to track when users click facet filters in your user interface.
Sending this event is useful for:
You can’t send these events for numeric filters.
Examples
Read the Algolia CLI documentation for more information.
1
2
3
4
5
6
7
8
9
10
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
'YourApplicationID',
'YourSearchOnlyAPIKey'
);
$insights->user("user-123456")->clickFilters(
'your_event_name',
'your_index_name',
['brand:apple']
);
Parameters
userToken
|
type: string
pattern:
[A-Za-z0-9_-=]{1,128}
Required
A pseudonymous or anonymous user identifier. Never include personal identifiable information in user tokens. Related: user token |
eventName
|
type: string
pattern:
[\x20-\x7E]{1,64}
Required
The name of the specific event. Format: 1-64 ASCII characters, except control characters. To maximize the impact of your events, you should use consistent event names and consistent formatting—for example, “Product Added To Cart” (always in title case). For example, you can adopt Segment’s object-action framework. |
indexName
|
type: string
Required
The name of the Algolia index. Format: same as the index name used by the search engine. Some API clients use |
filters
|
type: array
items: string
pattern:
${attr}:${value}
Required
An array of facet filters. You can include up to 10 filters. Format: |
Response
This method doesn't return a response.