Clicked Object IDs | Ruby API Client V1 (Deprecated)
This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.
settings
ACL
About this method
Send a click event to capture clicked items.
Note that unlike clickedObjectIDsAfterSearch
, clickedObjectIDs
doesn’t take a queryID
. Therefore, clickedObjectID
events only go towards personalization. clickedObjectIDsAfterSearch
events go towards both Personalization and Click and Conversion 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. 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 objectIDs. Limited to 20 objectIDs. |
Response
No response.