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
});

See code examples

About this method

Send a conversion event to capture clicked items.

Note that unlike convertedObjectIDsAfterSearch, convertedObjectIDs doesn’t take a queryID. Therefore, the captured event goes towards only personalization. convertedObjectIDs goes towards both Personalization and Click and Conversion Analytics.

You can find examples of click, conversion, and view events in the Search Analytics section.

Examples

Copy

Copy
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

$insights->user("user-1")->convertedObjectIDs(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2']
);

Copy
insights = Algolia::Insights.new(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
)

insights.user('userToken').converted_object_ids(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2']
)

Copy
// 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('convertedObjectIDs', {
  userToken: "user-1",
  index: 'your_index_name',
  eventName: "your_event_name',
  objectIDs: ['objectID1', 'objectID2']
});

Copy
insights = InsightsClient.create(
    'YourApplicationID',
    'YourSearchOnlyAPIKey'
)

insights.user('user-1').converted_object_ids(
  'your_event_name',
  'your_index_name',
  ['objectID1', 'objectID2']
)

Copy
Insights.register(
  appId: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey",
  userToken: "user-1"
)

Insights.shared?.converted(
  eventName: "your_event_name",
  indexName: "your_index_name",
  objectIDs: ["objectID1", "objectID2"]
)

Copy
Insights.register(
  context,
  "YourApplicationID",
  "YourSearchOnlyAPIKey",
  "user-1"
)

Insights.shared?.converted(
  "your_event_name",
  "your_index_name",
  EventObjects.IDs("objectID1", "objectID2")
)

Copy
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-1");

insights.ConvertedObjectIDs(
  "your_event_name",
  "your_index_name",
  new List<string> { "objectID1", "objectID2" }
);

Copy
UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-1");

insights.convertedObjectIDs(
  "your_event_name",
  "your_index_name",
  Arrays.asList("objectID1", "objectID2")
);

Copy
client := insights.NewClient(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).User("user-1")

res, err := client.ConvertedObjectIDs(
	"your_event_name",
	"your_index_name",
	[]string{"objectID1", "objectID2"},
)

Copy
val userToken = UserToken("user-id")

clientInsights.User(userToken).convertedObjectIDs(
    indexName = IndexName("indexName"),
    eventName = EventName("eventName"),
    objectIDs = listOf(ObjectID("objectID1"), ObjectID("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?

Converted Object IDs | JavaScript API Client V3 (Deprecated)

About this method

Examples

Parameters

Response

On this page