Skip to main content
Required ACL: search Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, users add the item to their shopping cart. If you use Algolia to build your category pages, you’ll also use the convertedObjectIDsAfterSearch event. For details where this event is used, see Event types. Related methods:

Examples

For more information about initializing the JavaScript Insights client aa, see Initialize the Insights client.
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-123456");

insights.ConvertedObjectIDsAfterSearch(
  "Product Converted",
  "YourIndexName",
  new List<string> { "objectID-1", "objectID-2" },
  "queryId"
);

Parameters

eventName
string
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 Twilio Segment’s object-action framework.
indexName
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.
objectIDs
string[]
required
List of object IDs for items of an Algolia index.You can include up to 20 object IDs.
queryID
string
required
Unique identifier for a search query.A queryID is required for events related to search or browse requests.If you add clickAnalytics: true as a search request parameter, the queryID is included in the API response.See also: Keep track of query IDs
userToken
string
required
Anonymous user identifier.See also: User token
authenticatedUserToken
string
Pseudonymous identifier for authenticated users.
Don’t include personally identifiable information in user tokens.
See also: User token
I