API Reference / API Methods / Insights / Clicked Object IDs

Clicked Object IDs

Required API Key: any key with the settings ACL
Method signature
$insights->user(string userToken)->clickedObjectIDs(
  string eventName,
  string indexName,
  array objectIDs
)

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

Send a click event to capture clicked items.

Note that unlike clickedObjectIDsAfterSearch, clickedObjectIDs does not take a queryID. Therefore, clickedObjectID events only go towards personalization. clickedObjectIDsAfterSearch events go towards both personalization and search analytics.

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
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

$insights->user("userToken")->clickedObjectIDs(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2']
);

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.

We strongly encourage you to follow our 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 objectIDs.

Limited to 20 objectIDs.

Response

No response

Did you find this page helpful?