Viewed Filters | JavaScript API Client V3 (Deprecated)

Deprecated content

This documentation is for a deprecated version of JavaScript API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of JavaScript API client for up-to-date information.

Required API Key: any key with the settings ACL

Method signature

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

See code examples

About this method

Send a view event to capture the filters a user uses when viewing.

Examples

Copy

Copy
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

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

Copy
insights = Algolia::Insights.new(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
)

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

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

Copy
insights = InsightsClient.create(
    'YourApplicationID',
    'YourSearchOnlyAPIKey'
)

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

Copy
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"]
)

Copy
Insights.register(
  context,
  "YourApplicationID",
  "YourSearchOnlyAPIKey",
  "user-1"
)

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

Copy
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-1");

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

Copy
UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-1");

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

Copy
client := insights.NewClient(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).User("user-1")

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

Copy
val userToken = UserToken("user-id")

clientInsights.User(userToken).viewedFilters(
    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. Format: any ascii char 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}${op}${value}` e.g. brand:apple. Limited to 10 filters.

Response

No response.

Did you find this page helpful?

Viewed Filters | JavaScript API Client V3 (Deprecated)

About this method

Examples

Parameters

Response

On this page