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

Deprecated content

This documentation is for a deprecated version of JavaScript API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of JavaScript API client for up-to-date information.

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

See code examples

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

Copy

Copy
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

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

Copy
insights = Algolia::Insights.new(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
)

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

Copy
// 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',
  index: 'your_index_name',
  queryID: 'queryID',
  objectIDs: ['objectID1', 'objectID2'],
  positions: [17, 19],
});

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

Copy
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"
)

Copy
Insights.register(
  context,
  "YourApplicationID",
  "YourSearchOnlyAPIKey",
  "user-1"
)

Insights.shared?.clickedAfterSearch(
  "your_event_name",
  "your_index_name",
  "queryID",
  EventObjects.IDs("objectID1", "objectID2"),
  listOf(17, 19)
)

Copy
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"
);

Copy
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");

Copy
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",
)

Copy
client.execute {
  send event ClickedObjectIDsAfterSearch(
    "user-1",
    "your_event_name",
    "your_index_name",
    Seq("objectID1", "objectID2"),
    Seq(17, 19),
    "queryID"
  )
}

Copy
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")
)

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?

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

About this method

Examples

Parameters

Response

On this page