Skip to main content
Required ACL: search Use this event to track when users click facet filters in your user interface. For details where this event is used, see Event types.
You can’t send these events for numeric filters.

​
Examples

For more information about initializing the JavaScript Insights client aa, see Initialize the Insights client.
JavaScript
aa("clickedFilters", {
  userToken: "anonymous-123456", // required for Node.js
  authenticatedUserToken: "user-123456",
  index: "YourIndexName",
  eventName: "Brand Clicked",
  filters: ["brand:apple"],
});

​
Parameters

​
eventName
string
required
Name of the specific event.Format: 1-64 ASCII characters, except control characters.To maximize the impact of your events, use consistent event names and consistent formatting—for example, “Product Added To Cart” (always in title case).For example, you can adopt Twilio Segment’s object-action framework.
​
filters
string[]
required
List of facet filters.You can include up to 10 filters.Format: ${attribute}:${value}—for example, brand:apple. Both the attribute and value in each facet filter must be URL-encoded individually and separated by a :, such as, "discount:10%25".
​
indexName
string
required
Name of the Algolia index.Format: same as the index name used by the search engine.Some API clients use index instead of indexName.
​
userToken
string
required
Anonymous user identifier.See also: User token
​
authenticatedUserToken
string
Pseudonymous identifier for authenticated users.
Don’t include personally identifiable information in user tokens.
See also: User token
⌘I