Clicked object IDs after search

Required API Key: any key with the search ACL

Method signature

$insights->user(string userToken)->clickedObjectIDsAfterSearch(
  string eventName,
  string indexName,
  array objectIDs,
  array positions,
  string queryID
)

insights.user(String userToken).clicked_object_ids_after_search(
  String eventName,
  String indexName,
  Array objectIDs,
  Array positions,
  String queryID
)

aa('clickedObjectIDsAfterSearch', {
    userToken: string,
    authenticatedUserToken: string,
    index: string,
    eventName: string,
    queryID: string,
    objectIDs: array,
    positions: array
});

insights.user(str userToken).clicked_object_ids_after_search(
  str eventName,
  str indexName,
  list objectIDs,
  list positions,
  str queryID
)

insights.clickedAfterSearch(
  eventName: String,
  indexName: String,
  objectIDs: [String],
  positions: [String],
  queryID: String,
  userToken: String
)

suspend fun ClientInsights.User.clickedObjectIDsAfterSearch(
    indexName: IndexName,
    eventName: EventName,
    queryID: QueryID,
    objectIDs: List<ObjectID>,
    positions: List<Int>,
    timestamp: Long? = null
): HttpResponse

insights.User(String userToken).ClickedObjectIDsAfterSearch(
  String eventName,
  String indexName,
  List<String> objectIDs,
  List<String> positions,
  String queryID
)

insights.user(String userToken).clickedObjectIDsAfterSearch(
  String eventName,
  String indexName,
  List<String> objectIDs,
  List<Long> positions,
  String queryID
)

client.User(string userToken).ClickedObjectIDsAfterSearch(
  string eventName,
  string indexName,
  []string objectIDs,
  []int positions,
  string queryID,
)

send event ClickedObjectIDsAfterSearch(
  String userToken,
  String eventName,
  String indexName,
  Iterable<String> objectIDs,
  Iterable<Int> positions,
  String queryID
)

See code examples

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 click event related to an Algolia request.

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.

Sending this event is useful for:

Related methods:

clickedObjectIDs: track click events not related to Algolia requests.
sendEvents: if you don’t want to send real-time events.

Guides Get started with click and conversion events

Send click and conversion events with InstantSearch

Send click and conversion events with Autocomplete

API Insights API

Examples

Read the Algolia CLI documentation for more information.

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 Insights client aa, see Initialize the Insights client.

Copy

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

$insights->user("user-123456")->clickedObjectIDsAfterSearch(
  'Product Clicked',
  'YourIndexName',
  ['objectID-1'],
  [2],
  'queryID'
);

1
2
3
4
5
6
7
8
9
insights = Algolia::Insights::Client.create('YourApplicationID', 'YourSearchOnlyAPIKey')

insights.user('user-123456').clicked_object_ids_after_search(
  'Product Clicked',
  'YourIndexName',
  ['objectID-1'],
  [2],
  'queryID'
)

1
2
3
4
5
6
7
8
9
10
11
// This requires the `search-insights` library

aa('clickedObjectIDsAfterSearch', {
  userToken: 'anonymous-123456',  // required for Node.js
  authenticatedUserToken: 'user-123456',
  eventName: 'Product Clicked',
  index: 'YourIndexName',
  queryID: 'queryID',
  objectIDs: ['objectID-1'],
  positions: [2],
});

1
2
3
4
5
6
7
8
9
10
11
12
insights = InsightsClient.create(
    "YourApplicationID",
    "YourSearchOnlyAPIKey"
)

insights.user("user-123456").clicked_object_ids_after_search(
    "Product Clicked",
    "YourIndexName",
    ["objectID-1"],
    [2],
    "queryID"
)

1
2
3
4
5
6
7
8
9
10
11
12
13
Insights.register(
  appId: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey",
  userToken: "user-123456"
)

Insights.shared?.clickedAfterSearch(
  eventName: "Product Clicked",
  indexName: "YourIndexName",
  objectIDs: ["objectID-1"],
  positions: [2],
  queryID: "queryID"
)

1
2
3
4
5
6
7
8
9
val userToken = UserToken("user-123456")

clientInsights.User(userToken).clickedObjectIDsAfterSearch(
    indexName = IndexName("YourIndexName"),
    eventName = EventName("Product Clicked"),
    objectIDs = listOf(ObjectID("objectID-1")),
    positions = listOf(2),
    queryID = QueryID("queryID")
)

1
2
3
4
5
6
7
8
9
10
11
12
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-123456");

insights.ClickedObjectIDsAfterSearch(
  "Product Clicked",
  "YourIndexName",
  new List<string> { "objectID-1" },
  new List<uint> { 2 },
  "queryID"
);

1
2
3
4
5
6
7
8
9
10
UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-123456");

insights.clickedObjectIDsAfterSearch(
  "Product Clicked",
  "YourIndexName",
  Arrays.asList("objectID-1"),
  Arrays.asList(2L)),
  "queryID");

1
2
3
4
5
6
7
8
9
10
11
12
client := insights.NewClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey",
).User("user-123456")

res, err := client.ClickedObjectIDsAfterSearch(
  "Product Clicked",
  "YourIndexName",
  []string{"objectID-1"},
  []int{2},
  "queryID",
)

1
2
3
4
5
6
7
8
9
10
client.execute {
  send event ClickedObjectIDsAfterSearch(
    "user-123456",
    "Product Clicked",
    "YourIndexName",
    Seq("objectID-1"),
    Seq(2),
    "queryID"
  )
}

Parameters

Parameter	Description
`userToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Required Anonymous user identifier. See also: User Token
`authenticatedUserToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Optional Pseudonymous identifier for authenticated users. Never include personally 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`.
`objectIDs`	type: array items: string Required List of object identifiers for items of an Algolia index. You can include up to 20 `objectID`.
`positions`	type: array items: uint Required Positions of the clicked objects 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 `objectID`. 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`	type: string pattern: `[a-f0-9]{32}` 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

Response

This method doesn't return a response.

Did you find this page helpful?

Clicked object IDs after search

About this method

Examples

Parameters

Response

On this page