Converted object IDs

Required API Key: any key with the search 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,
  authenticatedUserToken: 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,
  Iterable<String> objectIDs
)

See code examples

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 Java API client in public beta. Read the beta documentation for more information.

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.

About this method

Send a conversion event to capture clicked items.

Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don’t use Algolia to build your category pages, use convertedObjectIDs.

Sending this event is useful for:

Related methods:

convertedObjectIDsAfterSearch: track conversion events related to Algolia requests.
sendEvents: if you don’t want to send real-time events.

Guides Get started with click and conversion events

Send click and conversion events with InstantSearch

Send click and conversion events with Autocomplete

API Insights API

Examples

Read the Algolia CLI documentation for more information.

For more information about initializing the Insights client aa, see Initialize the Insights client.

Copy

1
2
3
4
5
6
7
8
9
10
$insights = Algolia\AlgoliaSearch\InsightsClient::create(
  'YourApplicationID',
  'YourSearchOnlyAPIKey'
);

$insights->user("user-123456")->convertedObjectIDs(
  'Product Added To Wishlist',
  'YourIndexName',
  ['objectID-1', 'objectID-2']
);

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

insights.user('user-123456').converted_object_ids(
  'Product Added To Wishlist',
  'YourIndexName',
  ['objectID-1', 'objectID-2']
)

1
2
3
4
5
6
7
8
9
// This requires the `search-insights` library

aa('convertedObjectIDs', {
  userToken: 'anonymous-123456', // required for Node.js
  authenticatedUserToken: 'user-123456',
  index: 'YourIndexName',
  eventName: 'Product Added To Wishlist',
  objectIDs: ['objectID-1', 'objectID-2']
});

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

insights.user("user-123456").converted_object_ids(
  "Product Added To Wishlist",
  "YourIndexName",
  ["objectID-1", "objectID-2"]
)

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

Insights.shared?.converted(
  eventName: "Product Added To Wishlist",
  indexName: "YourIndexName",
  objectIDs: ["objectID-1", "objectID-2"]
)

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

clientInsights.User(userToken).convertedObjectIDs(
    indexName = IndexName("YourIndexName"),
    eventName = EventName("Product Added To Wishlist"),
    objectIDs = listOf(ObjectID("objectID-1"), ObjectID("objectID-2"))
)

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

insights.ConvertedObjectIDs(
  "Product Added To Wishlist",
  "YourIndexName",
  new List<string> { "objectID-1", "objectID-2" }
);

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

insights.convertedObjectIDs(
  "Product Added To Wishlist",
  "YourIndexName",
  Arrays.asList("objectID-1", "objectID-2")
);

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

res, err := client.ConvertedObjectIDs(
	"Product Added To Wishlist",
	"YourIndexName",
	[]string{"objectID-1", "objectID-2"},
)

1
2
3
4
5
6
7
8
client.execute {
  send event ConvertedObjectIDs(
    "user-123456",
    "Product Added To Wishlist",
    "YourIndexName",
    Seq("objectID-1", "objectID-2")
  )
}

Parameters

Parameter	Description
`userToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Required Anonymous user identifier. See also: User Token
`authenticatedUserToken`	type: string pattern: `[A-Za-z0-9_=+/-]{1,129}` Optional Pseudonymous identifier for authenticated users. Never include personally identifiable information in user tokens. See also: User Token
`eventName`	type: string pattern: `[\x20-\x7E]{1,64}` Required Name of the specific event. Format: 1-64 ASCII characters, except control characters. To maximize the impact of your events, use consistent event names and consistent formatting—for example, “Product Added To Cart” (always in title case). For example, you can adopt Segment’s object-action framework.
`indexName`	type: string Required Name of the Algolia index. Format: same as the index name used by the search engine. Some API clients use `index` instead of `indexName`.
`objectIDs`	type: array items: string Required List of object identifiers for items of an Algolia index. You can include up to 20 `objectID`.

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