Clicked Filters | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

Required API Key: any key with the settings ACL

Method signature

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

See code examples

About this method

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

Examples

Copy

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

1
2
3
4
5
6
7
8
9
10
insights = Algolia::Insights.new(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
)

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',
  index: 'your_index_name',
  eventName: 'your_index_name',
  filters: [ 'brand:apple' ]
});

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

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: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey",
  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
11
12
Insights.register(
  context,
  "YourApplicationID",
  "YourSearchOnlyAPIKey",
  "user-1"
)

Insights.shared?.clicked(
  "your_event_name",
  "your_index_name",
  EventObjects.Filters("brand:apple")
)

1
2
3
4
5
6
7
8
9
10
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).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("YourApplicationID","YourSearchOnlyAPIKey")
    .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(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).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

`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. 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}${op}${value}` e.g. brand:apple. Limited to 10 filters.

Response

No response.

Did you find this page helpful?

Clicked Filters | Ruby API Client V1 (Deprecated)

About this method

Examples

Parameters

Response

On this page