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

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

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

Read the Algolia CLI documentation for more information.

Copy

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']
);

1
2
3
4
5
6
7
insights = Algolia::Insights::Client.create('YourApplicationID', 'YourSearchOnlyAPIKey')

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

1
2
3
4
5
6
7
8
9
10
11
// 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", // required for Node.js
  index: 'your_index_name',
  eventName: "your_event_name',
  objectIDs: ['objectID1', 'objectID2']
});

1
2
3
4
5
6
7
8
9
10
insights = InsightsClient.create(
    'YourApplicationID',
    'YourSearchOnlyAPIKey'
)

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

1
2
3
4
5
6
7
8
9
10
11
Insights.register(
  appId: "YourApplicationID",
  apiKey: "YourSearchOnlyAPIKey",
  userToken: "user-1"
)

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

1
2
3
4
5
6
7
val userToken = UserToken("user-id")

clientInsights.User(userToken).convertedObjectIDs(
    indexName = IndexName("indexName"),
    eventName = EventName("eventName"),
    objectIDs = listOf(ObjectID("objectID1"), ObjectID("objectID2"))
)

1
2
3
4
5
6
7
8
9
10
var insights = new InsightsClient(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
).User("user-1");

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

1
2
3
4
5
6
7
8
9
UserInsightsClient insights = DefaultInsightsClient
    .create("YourApplicationID","YourSearchOnlyAPIKey")
    .user("user-1");

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

1
2
3
4
5
6
7
8
9
10
client := insights.NewClient(
	"YourApplicationID",
	"YourSearchOnlyAPIKey",
).User("user-1")

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

Parameters

`userToken`	type: string Required A user identifier. Format: alpha numeric string [a-zA-Z0-9_-=/+]{1,128} Length: between 1 and 64 characters.
`eventName`	type: string Required Name of the event. It’s best to follow the 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.

Response

This method doesn't return a response.

Did you find this page helpful?

Converted Object IDs

About this method

Examples

Parameters

Response

On this page