Skip to main content
Required ACL: search Use this event to track when users click items in the search results. If you’re using Algolia to build your category pages, you’ll also use the clickedObjectIDsAfterSearch event. For details where this event is used, see Event types. Related methods:

​
Examples

The following example sends one click event to the Algolia Insights API. The event represents a user user-123456 clicking on the item objectID-1, which is at the second position in the results from the index your_index_name For more information about initializing the JavaScript Insights client aa, see Initialize the Insights client.
JavaScript
aa("clickedObjectIDsAfterSearch", {
  userToken: "anonymous-123456", // required for Node.js
  authenticatedUserToken: "user-123456",
  eventName: "Product Clicked",
  index: "YourIndexName",
  queryID: "queryID",
  objectIDs: ["objectID-1"],
  positions: [2],
});

​
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 records of an Algolia index.You can include up to 20 object IDs.
​
positions
string[]
required
Positions of the clicked results in the search results. This property is required for click events with queryID. The first search result has a position of 1 (not 0).You must provide one position for each object ID.Algolia uses this parameter to calculate the average click position.The position is absolute, and not relative, to any results page. For example, if there are 10 results per page, the position of the third record of the second results page is 13. Since page starts at 0, you can use the following formula: positionOnPage + page * hitsPerPage.
​
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