Purchased object IDs

This method is only available for JavaScript.

Required API Key: any key with the search ACL

Method signature

Only available for JavaScript

Only available for JavaScript

aa('purchasedObjectIDs', {
  userToken: string,
  authenticatedUserToken: string,
  eventName: string,
  index: string,
  objectIDs: array,
  objectData: array,
  value: string,
  currency: string
});

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

Only available for JavaScript

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 when users purchase items.

Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don’t use Algolia to build your category pages, use purchasedObjectIDs.

Sending this event is useful for:

Related methods:

purchasedObjectIDsAfterSearch: track conversion purchase 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
// This requires the `search-insights` library

aa('purchasedObjectIDs', {
  userToken: 'anonymous-123456', // required for Node.js
  authenticatedUserToken: 'user-123456',
  eventName: 'your_event_name',
  index: 'your_index_name',
  objectIDs: ['objectID-1', 'objectID-2'],
  objectData: [
    {
      price: 19.99,
      discount: 3.99,
      quantity: 3
    },
    {
      price: 59.99,
      quantity: 2
    }
  ],
  value: 179.95,
  currency: 'USD'
});

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`.
`objectData`	type: array items: ObjectData Optional Extra information about the records involved in the event—for example, to add price and quantities of purchased products. If provided, must be the same length as `objectIDs`.
`value`	type: number \| string Optional The monetary value of the event, measured in `currency`. For example, the total value of a purchase.
`currency`	type: string Optional If you include pricing information in the `objectData` parameter or provide `value`, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.

ObjectData

Parameter	Description
`price`	type: number \| string Optional The price of the item. This should be the final price, inclusive of any discounts in effect.
`quantity`	type: number Optional The quantity of the purchased or added-to-cart item. The total value of a purchase is the sum of `quantity` multiplied with the `price` for each purchased item.
`discount`	type: number \| string Optional Absolute value of the discount in effect for this object, measured in `currency`.

Response

This method doesn't return a response.