Viewed Filters

Required API Key: any key with the settings ACL

Method signature

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

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

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

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

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

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

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

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

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

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

See code examples

About this method

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 JavaScript 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 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.

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.

A user browsing on a category page usually sees content filtered on that specific category. However, they haven’t clicked on or interacted with that filter. In scenarios where a user sees filtered content without interacting with that filter, you send view events.

Sending a view event captures the filters a user sees when viewing filtered content without having actively filtered it.

Examples

Read the Algolia CLI documentation for more information.

Copy

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

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

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

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

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('viewedFilters', {
  userToken: 'user-1', // 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-1').viewed_filters(
    'your_event_name',
    'your_index_name',
    ['brand:apple', 'brand:google']
)

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

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

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

clientInsights.User(userToken).viewedFilters(
    indexName = IndexName("indexName"),
    eventName = EventName("eventName"),
    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-1");

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

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

insights.viewedFilters(
  "your_event_name",
  "your_index_name",
  Arrays.asList("brand:apple", "brand:google")
);

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

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

Parameters

`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 view.
`filters`	type: string[] Required A list of `filters`. Format: `${attr}:${value}` e.g. brand:apple. Limited to 10 filters.

Response

This method doesn't return a response.

Did you find this page helpful?

Viewed Filters

About this method

Examples

Parameters

Response

On this page