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,
    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<String> 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,
  List<String> objectIDs,
  List<String> positions,
  String queryID
)

See code examples

About this method

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 JavaScript 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 JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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.

Send a click event to capture a query and its clicked items and positions.

Unlike clickedObjectIDs, ClickedObjectIDsAfterSearch takes a queryID.

The captured click event applies to both Personalization and Click and Conversion Analytics.
ClickedObjectIDs` only applies to personalization.

Guide Examples of click, conversion, and view events

Examples

Read the Algolia CLI documentation for more information.

Copy

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

$insights->user("user-1")->clickedObjectIDsAfterSearch(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2'],
  [17, 19],
  'queryID'
);

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

insights.user('userToken').clicked_object_ids_after_search(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2'],
  [17, 19],
  'queryID'
)

1
2
3
4
5
6
7
8
9
10
11
12
13
// This requires installing the search-insights separate library:
// https://github.com/algolia/search-insights.js
// https://www.npmjs.com/package/search-insights
// Compatible with Node.js since v1.3.0

aa('clickedObjectIDsAfterSearch', {
  userToken: 'user-1', // required for Node.js
  eventName: 'your_event_name',
  index: 'your_index_name',
  queryID: 'queryID',
  objectIDs: ['objectID1', 'objectID2'],
  positions: [17, 19],
});

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

insights.user('user-1').clicked_object_ids_after_search(
    'your_event_name',
    'your_index_name',
    ['objectID1', 'objectID2'],
    [17, 19],
    'queryID'
)

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

Insights.shared?.clickedAfterSearch(
  eventName: "your_event_name",
  indexName: "your_index_name",
  objectIDs: ["objectID1", "objectID2"],
  positions: [17, 19],
  queryID: "queryID"
)

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

clientInsights.User(userToken).clickedObjectIDsAfterSearch(
    indexName = IndexName("indexName"),
    eventName = EventName("eventName"),
    objectIDs = listOf(ObjectID("objectID1"), ObjectID("objectID2")),
    positions = listOf(17, 19),
    queryID = QueryID("queryID")
)

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

insights.ClickedObjectIDsAfterSearch(
  "your_event_name",
  "your_index_name",
  new List<string> { "objectID1", "objectID2" },
  new List<uint> { 17, 19 },
  "queryID"
);

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

insights.clickedObjectIDsAfterSearch(
  "your_event_name",
  "your_index_name",
  Arrays.asList("objectID1", "objectID2"),
  new ArrayList<>(Arrays.asList(17l,19l)),
  "queryID");

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

res, err := client.ClickedObjectIDsAfterSearch(
  "your_event_name",
  "your_index_name",
  []string{"objectID1", "objectID2"},
  []int{17, 19},
  "queryID",
)

1
2
3
4
5
6
7
8
9
10
client.execute {
  send event ClickedObjectIDsAfterSearch(
    "user-1",
    "your_event_name",
    "your_index_name",
    Seq("objectID1", "objectID2"),
    Seq(17, 19),
    "queryID"
  )
}

Parameters

`userToken`	type: string Required A user identifier. Format: alpha numeric string [a-zA-Z0-9_-=/+]{1,128} Length: between 1 and 64 characters.
`eventName`	type: string Required Name of the event. It’s best to follow the event naming guidelines. Format: any ASCII character except control characters. Length: between 1 and 64 characters.
`indexName`	type: string Required Name of the index related to the click.
`objectIDs`	type: string[] Required A list of up to 20 objectIDs. This list is often just one click (objectID), but there are cases where users can select multiple objects (for instance, selecting multiple options and then clicking “Submit”).
`positions`	type: uint[] Required Position of the click in the list of Algolia search results. The first object in the list of search results has a position of 1 (not zero), the second has a position of 2, etc. The position value must be absolute, not relative to the result page. For example, when clicking on the third record on the second result page, assuming 10 results per page, the position should be 13, not 3.
`queryID`	type: string Required Algolia queryID in the search response when using `clickAnalytics` Format: hexadecimal string [a-f0-9] Length: 32 characters.

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