Api clients
/
Ruby
/
V1
/
Methods
Aug 14, 2024
Converted Filters | Ruby API Client V1 (Deprecated)
Deprecated content
This documentation is for a deprecated version of Ruby API client .
Some features and settings may be missing or their usage may have changed.
Refer to the documentation for the
latest version of Ruby API client for up-to-date information.
Required API Key: any key with the
settings
ACL
About this method
Send a conversion event to capture the filters a user uses when converting.
Examples
Copy
1
2
3
4
5
6
7
8
9
10
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
'YourApplicationID',
'YourSearchOnlyAPIKey'
);
$insights->user("user-1")->convertedFilters(
'your_event_name',
'your_index_name',
['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 character except control characters. Length: between 1 and 64 characters. |
indexName
|
type: string
Required
Name of the index related to the conversion. |
filters
|
type: string[]
Required
A list of Format: Limited to 10 filters. |
Response
No response.
Did you find this page helpful?