API Reference / API Methods / Insights / Converted Objects IDs After Search
Feb. 26, 2019

Converted Objects IDs After Search

Required API Key: any key with the settings ACL
Method signature
$insights->user(string userToken)->convertedObjectIDsAfterSearch(
  string eventName,
  string indexName,
  array objectIDs,
  string queryID
)

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 search 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.

We strongly encourage you to follow our 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 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

Did you find this page helpful?