API Reference / API Methods / Insights / Clicked Object IDs After Search

Feb. 26, 2019

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.clickedAfterSearch(
  String eventName,
  String indexName,
  String queryID,
  EventObjects.IDs(objectIDs),
  positions
)

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

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

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

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

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

// This requires installing the search-insights separate library:
// https://github.com/algolia/search-insights.js
// https://www.npmjs.com/package/search-insights

aa('clickedObjectIDsAfterSearch', {
  userToken: 'user-1',
  index: 'your_index_name',
  queryID: 'queryID',
  objectIDs: ['objectID1', 'objectID2'],
  positions: [17, 19],
});

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

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

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

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

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

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

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

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

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

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Clicked Object IDs After Search

About this method

Examples

Parameters

Response

Did you find this page helpful?

On this page