API Reference / API Methods / Insights / Converted Object IDs

Feb. 26, 2019

Converted Object IDs

Required API Key: any key with the settings ACL

Method signature

$insights->user(string userToken)->convertedObjectIDs(
  string eventName,
  string indexName,
  array objectIDs
)

insights.user(String userToken).converted_object_ids(
  String eventName,
  String indexName,
  Array objectIDs
)

aa('convertedObjectIDs', {
  userToken: string,
  index: string,
  eventName: string,
  objectIDs: array
});

insights.user(str userToken).converted_object_ids(
  str eventName,
  str indexName,
  list objectIDs
)

insights.converted(
  eventName: String ,
  indexName: String ,
  objectIDs: [String] ,
  userToken: String
)

suspend fun ClientInsights.User.convertedObjectIDs(
    indexName: IndexName,
    eventName: EventName,
    objectIDs: List<ObjectID>,
    timestamp: Long? = null
): HttpResponse

insights.converted(
  String eventName,
  String indexName,
  EventObjects.IDs(objectIDs)
)

insights.User(String userToken).ConvertedObjectIDs(
  String eventName,
  String indexName,
  List<String> objectIDs
)

insights.user(String userToken).convertedObjectIDs(
  String eventName,
  String indexName,
  List<String> objectIDs
)

client.User(string userToken).ConvertedObjectIDs(
  string eventName,
  string indexName,
  []string objectIDs,
)

send event ConvertedObjectIDs(
  String userToken,
  String eventName,
  String indexName,
  List<String> objectIDs
)

See code examples

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

Copy

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

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

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

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

// This requires installing the search-insights separate library:
// https://github.com/algolia/search-insights.js
// https://www.npmjs.com/package/search-insights

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Converted Object IDs

About this method

Examples

Parameters

Response

Did you find this page helpful?

On this page