Viewed filters

Required API Key: any key with the search 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,
  authenticatedUserToken: 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,
  Iterable<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 view event to capture the active filters for items a user viewed.

When users browse a category page, they see content filtered on that specific category.

To capture the active filters, send a viewEvent.

Sending this event is useful for:

Personalization

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")->viewedFilters(
  'Brand Viewed',
  'YourIndexName',
  ['brand:google']
);

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

insights.user('user-123456').viewed_filters(
  'Brand Viewed',
  'YourIndexName',
  ['brand:apple', 'brand:google']
)

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

aa('viewedFilters', {
  userToken: 'anonymous-123456', // required for Node.js
  authenticatedUserToken: 'user-123456',
  index: 'YourIndexName',
  eventName: 'Brand Viewed',
  filters: [ 'brand:apple' ]
});

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

insights.user("user-123456").viewed_filters(
    "Brand Viewed",
    "YourIndexName",
    ["brand:apple", "brand:google"]
)

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

Insights.shared?.viewed(
  eventName: "Brand Viewed",
  indexName: "YourIndexName",
  filters: ["brand:apple", "brand:google"]
)

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

clientInsights.User(userToken).viewedFilters(
    indexName = IndexName("YourIndexName"),
    eventName = EventName("Brand Viewed"),
    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.ViewedFilters(
  "Brand Viewed",
  "YourIndexName",
  new List<string> { "brand:apple", "brand:google" }
);

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

insights.viewedFilters(
  "Brand Viewed",
  "YourIndexName",
  Arrays.asList("brand:apple", "brand:google")
);

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

res, err := client.ViewedFilters(
	"Brand Viewed",
	"YourIndexName",
	[]string{"brand:apple", "brand:google"},
)

Parameters

Parameter	Description
`userToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Required Anonymous user identifier. See also: User Token
`authenticatedUserToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Optional Pseudonymous identifier for authenticated users. Never include personally 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?

Viewed filters

About this method

Examples

Parameters

Response

On this page