🎉 Try the public beta of the new docs site at algolia.com/doc-beta! 🎉
API client / Methods / Insights
Required API Key: any key with the search ACL
Method signature
$insights->user(string userToken)->convertedFilters(
  string eventName,
  string indexName,
  array filters
)

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 conversion event to capture the filters a user selected when converting.

Sending this event is useful for:

Examples

Read the Algolia CLI documentation for more information.

For more information on how to initialize the aa object, refer to Initialize the Insights client.

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

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

Parameters

userToken
type: string
pattern: [A-Za-z0-9_=+/-]{1,129}
Required

Pseudonymous or anonymous user identifier.

Never include personal 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?