Clicked object IDs
Required API Key:
any key with the
search
ACL
You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
About this method
Send a click event to capture clicked items.
Use this event to track when users click items unrelated to a previous Algolia request.
For example, if you don’t use Algolia to build your category pages,
use clickedObjectIDs
.
Sending this event is useful for:
Related methods:
clickedObjectIDsAfterSearch
: track click events related to Algolia requests.sendEvents
: if you don’t want to send real-time events.
Examples
Read the Algolia CLI documentation for more information.
For more information about initializing the Insights client aa
,
see Initialize the Insights client.
1
2
3
4
5
6
7
8
9
10
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
'YourApplicationID',
'YourSearchOnlyAPIKey'
);
$insights->user("user-123456")->clickedObjectIDs(
'Product Clicked',
'YourIndexName',
['objectID-1', 'objectID-2']
);
Parameters
userToken
|
type: string
pattern:
[A-Za-z0-9_=+/-]{1,129}
Required
Anonymous user identifier. See also: User Token |
authenticatedUserToken
|
type: string
pattern:
[A-Za-z0-9_=+/-]{1,129}
Optional
Pseudonymous identifier for authenticated users. Never include personally identifiable information in user tokens. See also: User Token |
eventName
|
type: string
pattern:
[\x20-\x7E]{1,64}
Required
Name of the specific event. Format: 1-64 ASCII characters, except control characters. To maximize the impact of your events, use consistent event names and consistent formatting—for example, “Product Added To Cart” (always in title case). For example, you can adopt Segment’s object-action framework. |
indexName
|
type: string
Required
Name of the Algolia index. Format: same as the index name used by the search engine. Some API clients use |
objectIDs
|
type: array
items: string
Required
List of object identifiers for items of an Algolia index. You can include up to 20 |
Response
This method doesn't return a response.