Required ACL: search
For details where this event is used, see Event types .
Examples
For more information about initializing the JavaScript Insights client aa,
see Initialize the Insights client .
C#
Go
Java
JavaScript
Kotlin
PHP
Python
Ruby
Scala
Swift
var insights = new InsightsClient (
"YourApplicationID" ,
"YourSearchOnlyAPIKey"
). User ( "user-123456" );
insights . ConvertedFilters (
"Brand Converted" ,
"YourIndexName" ,
new List < string > { "brand:apple" }
);
client := insights . NewClient (
"YourApplicationID" ,
"YourSearchOnlyAPIKey" ,
). User ( "user-123456" )
res , err := client . ConvertedFilters (
"Brand Converted" ,
"YourIndexName" ,
[] string { "brand:apple" },
)
UserInsightsClient insights = DefaultInsightsClient
. create ( "YourApplicationID" , "YourSearchOnlyAPIKey" )
. user ( "user-123456" );
insights . convertedFilters (
"Brand Converted" ,
"YourIndexName" ,
Collections . singletonList ( "brand:apple" )
);
// This requires the `search-insights` library
aa ( "convertedFilters" , {
userToken: "anonymous-123456" , // required for Node.js
authenticatedUserToken: "user-123456" ,
index: "YourIndexName" ,
eventName: "Brand Converted" ,
filters: [ "brand:apple" ],
});
val userToken = UserToken ( "user-123456" )
clientInsights. User (userToken). convertedFilters (
indexName = IndexName ( "YourIndexName" ),
eventName = EventName ( "Brand Converted" ),
filters = listOf (Filter. Facet ( Attribute ( "brand" ), "apple" ))
)
$insights = Algolia\AlgoliaSearch\ InsightsClient :: create (
'YourApplicationID' ,
'YourSearchOnlyAPIKey'
);
$insights -> user ( "user-123456" ) -> convertedFilters (
'Brand Converted' ,
'YourIndexName' ,
[ 'brand:apple' ]
);
insights = InsightsClient.create( "YourApplicationID" , "YourSearchOnlyAPIKey" )
insights.user( "user-123456" ).converted_filters(
"Brand Converted" , "YourIndexName" , [ "brand:apple" ]
)
insights = Algolia :: Insights :: Client . create ( "YourApplicationID" , "YourSearchOnlyAPIKey" )
insights. user ( "user-123456" ). converted_filters (
"Brand Converted" ,
"YourIndexName" ,
[ "brand:apple" ]
)
client.execute {
send event ConvertedFilters (
"user-123456" ,
"Brand Converted" ,
"YourIndexName" ,
Seq ( "filter" )
)
}
Insights. register (
appId : "YourApplicationID" ,
apiKey : "YourSearchOnlyAPIKey" ,
userToken : "user-123456"
)
Insights. shared ? . converted (
eventName : "Brand Converted" ,
indexName : "YourIndexName" ,
filters : [ "brand:apple" ]
)
Parameters
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 Twilio Segment’s object-action framework .
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".
Name of the Algolia index. Format : same as the index name used by the search engine.Some API clients use index instead of indexName.
Pseudonymous identifier for authenticated users. Don’t include personally identifiable information in user tokens.
See also: User token