Api clients
/
Ruby
/
V1
/
Methods
Jan. 29, 2021
Viewed 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.
Required API Key: any key with the
settings
ACL
About this method
Send a view event to capture clicked items.
Examples
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
'YourApplicationID',
'YourSearchOnlyAPIKey'
);
$insights->user("userToken")->viewedObjectIDs(
'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 view. |
objectIDs
|
type: string[]
Required
A list of objectIDs. Limited to 20 objectIDs. |
Response
No response.