Clicked filters

Required API Key: any key with the search ACL

Method signature

$insights->user(string userToken)->clickedFilters(
  string eventName,
  string indexName,
  array filters
)

insights.user(String userToken).clicked_filters(
  String eventName,
  String indexName,
  Array filters
)

aa('clickedFilters', {
  userToken: string,
  index: string,
  eventName: string,
  filters: array,
});

insights.user(str userToken).clicked_filters(
  str eventName,
  str indexName,
  list filters
)

insights.clicked(
  eventName: String,
  indexName: String,
  filters: [String],
  userToken: String
)

suspend fun ClientInsights.User.clickedFilters(
    indexName: IndexName,
    eventName: EventName,
    filters: List<Filter.Facet>,
    timestamp: Long? = null
): HttpResponse

insights.User(String userToken).ClickedFilters(
  String eventName,
  String indexName,
  List<String> filters
)

insights.user(String userToken).clickedFilters(
  String eventName,
  String indexName,
  List<String> filters
)

client.User(string userToken).ClickedFilters(
  string eventName,
  string indexName,
  []string filters,
)

send event ClickedFilters(
  String userToken,
  String eventName,
  String indexName,
  List<String> filters
)

See code examples

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 Java API client in public beta. Read the beta documentation for more information.

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:

Personalization

You can’t send these events for numeric filters.

Guides Get started with click and conversion events

Send click and conversion events with InstantSearch

Send click and conversion events with Autocomplete

API Insights API

Examples

Read the Algolia CLI documentation for more information.

For more information about initializing the Insights client aa, see Initialize the Insights client.

Copy

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']
);

1
2
3
4
5
6
7
insights = Algolia::Insights::Client.create('YourApplicationID', 'YourSearchOnlyAPIKey')

insights.user('user-123456').clicked_filters(
  'your_event_name',
  'your_index_name',
  ['brand:apple']
)

1
2
3
4
5
6
7
8
// This requires the `search-insights` library

aa('clickedFilters', {
  userToken: 'user-123456', // required for Node.js
  index: 'your_index_name',
  eventName: 'your_event_name',
  filters: [ 'brand:apple' ]
});

1
2
3
4
5
6
7
8
9
10
insights = InsightsClient.create(
    "YourApplicationID",
    "YourSearchOnlyAPIKey"
)

insights.user("user-123456").clicked_filters(
    "your_event_name",
    "your_index_name",
    ["brand:apple"]
)

1
2
3
4
5
6
7
8
9
10
11
Insights.register(
  appId: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey",
  userToken: "user-123456"
)

Insights.shared?.clicked(
  eventName: "your_event_name",
  indexName: "your_index_name",
  filters: ["brand:apple"]
)

1
2
3
4
5
6
7
val userToken = UserToken("user-123456")

clientInsights.User(userToken).clickedFilters(
    indexName = IndexName("your_index_name"),
    eventName = EventName("your_event_name"),
    filters = listOf(Filter.Facet(Attribute("brand"), "apple"))
)

1
2
3
4
5
6
7
8
9
10
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-123456");

insights.ClickedFilters(
  "your_event_name",
  "your_index_name",
  new List<string> { "brand:apple" }
);

1
2
3
4
5
6
7
8
9
UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-123456");

insights.clickedFilters(
  "your_event_name",
  "your_index_name",
  Collections.singletonList("brand:apple")
);

1
2
3
4
5
6
7
8
9
10
client := insights.NewClient(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).User("user-123456")

res, err := client.ClickedFilters(
	"your_event_name",
	"your_index_name",
	[]string{"brand:apple"},
)

Parameters

`userToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Required Pseudonymous or anonymous user identifier. Never include personal identifiable information in user tokens. See also: User Token
`eventName`	type: string pattern: `[\x20-\x7E]{1,64}` 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 Segment’s object-action framework.
`indexName`	type: 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`.
`filters`	type: array items: string pattern: `${attr}:${value}` 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"`.

Response

This method doesn't return a response.

Did you find this page helpful?

Clicked filters

About this method

Examples

Parameters

Response

On this page