Api clients / JavaScript / V3 / Methods

Clicked Object IDs After Search | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the search ACL
Method signature
aa('clickedObjectIDsAfterSearch', {
    userToken: string,
    index: string,
    eventName: string,
    queryID: string,
    objectIDs: array,
    positions: array
});

About this method

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

Note that unlike clickedObjectIDs, ClickedObjectIDsAfterSearch takes a queryID. Therefore, the captured event goes towards both personalization and search analytics. ClickedObjectIDs only goes towards personalization.

You can find examples of click, conversion, and view events in the search analytics section.

Examples

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'
);

Parameters

userToken
type: string
Required

A user identifier.

Format: alpha numeric string [a-zA-Z0-9_-]

Length: between 1 and 64 characters.

eventName
type: string
Required

Name of the event.

Format: any ASCII char 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 objectIDs.

Limited to 20 objectIDs.

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. In addition, the position value must be absolute, not relative, to the result page. For example, when clicking on the 3rd record of the 2nd result page, assuming 10 results per page, the position should be 13.

queryID
type: string
Required

Algolia queryID that can be found in the search response when using clickAnalytics

format: [a-z1-9]{32}

Response

No response.

Did you find this page helpful?