Api clients / Ruby / V1 / Methods

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.

Required API Key: any key with the settings ACL
Method signature
insights.user(String userToken).clicked_object_ids(
  String eventName,
  String indexName,
  Array objectIDs
)

About this method# A

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# A

1
2
3
4
5
6
7
8
9
10
11
// This requires installing the search-insights separate library:
// https://github.com/algolia/search-insights.js
// https://www.npmjs.com/package/search-insights
// Compatible with Node.js since v1.3.0

aa('clickedObjectIDs', {
  userToken: 'user-1',
  index: 'your_index_name',
  eventName: 'your_event_name',
  objectIDs: ['objectID1', 'objectID2']
});

Parameters# A

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# A

No response.

Did you find this page helpful?