Converted Objects IDs After Search | JavaScript API Client V3 (Deprecated)
settings
ACL
aa('convertedObjectIDsAfterSearch', { userToken: string, index: string, eventName: string, queryID: string, objectIDs: array });
About this method
Send a conversion event to capture a query and its clicked items.
Note that unlike convertedObjectIDs
, convertedObjectIDsAfterSearch
takes a queryID
. Therefore, the captured event goes towards both Personalization and Click and Conversion Analytics. convertedObjectIDs
only goes towards personalization.
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
11
$insights = Algolia\AlgoliaSearch\InsightsClient::create
'YourApplicationID',
'YourSearchOnlyAPIKey'
);
$insights->user("user-1")->convertedObjectIDsAfterSearch(
'your_event_name',
'your_index_name',
['objectID1', 'objectID2'],
'queryID'
);
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. |
queryID
|
type: string
Required
Algolia queryID, format: [a-z1-9]{32}. |
Response
No response.