Api clients / JavaScript / V3 / Methods

Converted Object IDs | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the settings ACL
Method signature
aa('convertedObjectIDs', {
  userToken: string,
  index: string,
  eventName: string,
  objectIDs: array
});

About this method

Send a conversion event to capture clicked items.

Note that unlike convertedObjectIDsAfterSearch, convertedObjectIDs does not take a queryID. Therefore, the captured event goes towards only personalization. convertedObjectIDs goes 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("user-1")->convertedObjectIDs(
  '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.

Format: any ascii char except control characters.

Length: between 1 and 64 characters.

indexName
type: string
Required

Name of the index related to the conversion.

objectIDs
type: string[]
Required

A list of objectIDs.

Limited to 20 objectIDs.

Response

No response.

Did you find this page helpful?