Clicked Filters

Required API Key: any key with the settings 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

About this method # A

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.

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

You can’t send these events for numeric filters.

Examples # A

Copy

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

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

1
2
3
4
5
6
7
insights = Algolia::Insights::Client.create('AJ0P3S7DWQ', '90dfaaf5755e694f341fe68f6e41a6d4')

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

1
2
3
4
5
6
7
8
9
10
11
// This requires installing the search-insights separate library:
// https://github.com/algolia/search-insights.js
// https://www.npmjs.com/package/search-insights
// Compatible with Node.js since v1.3.0

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

1
2
3
4
5
6
7
8
9
10
insights = InsightsClient.create(
    'AJ0P3S7DWQ',
    '90dfaaf5755e694f341fe68f6e41a6d4'
)

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

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

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

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

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("AJ0P3S7DWQ","90dfaaf5755e694f341fe68f6e41a6d4")
    .user("user-1");

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(
	"AJ0P3S7DWQ",
	"90dfaaf5755e694f341fe68f6e41a6d4",
).User("user-1")

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

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

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

Parameters # A

`userToken` #	type: string Required A user identifier. Format: alpha numeric string [a-zA-Z0-9_-=/+]{1,128} 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 click.
`filters` #	type: string[] Required A list of `filters`. Format: `${attr}:${value}` e.g. brand:apple. Limited to 10 filters.

Response # A

No response

Did you find this page helpful?

Clicked Filters

About this method # Found an issue? Edit this page A Edit this page

Examples # Found an issue? Edit this page A Edit this page

Parameters # Found an issue? Edit this page A Edit this page

Response # Found an issue? Edit this page A Edit this page

On this page

About this method # A

Examples # A

Parameters # A

Response # A