API Reference / API Methods / Insights / Clicked Filters

Clicked Filters

Required API Key: any key with the settings ACL
Method signature
$insights->user(string userToken)->clickedFilters(
  string eventName,
  string indexName,
  array filters
)

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

Send a click event to capture the filters a user clicks on.

Examples

1
2
3
4
5
6
7
8
9
10
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

$insights->user("user-1")->clickFilters(
  'your_event_name',
  'your_index_name',
  ['brand:apple']
);

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.

We strongly encourage you to follow our 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 click.

filters
type: string[]
Required

A list of filters.

Format: ${attr}${op}${value} e.g. brand:apple.

Limited to 10 filters.

Response

No response

Did you find this page helpful?