Purchased object IDs

Send a conversion event to capture when users purchase items.

Required ACL: search

This method is available in the JavaScript library for the Insights API search-insights.

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.

For details, where this event is used, see Event types.

Related methods:

• purchasedObjectIDsAfterSearch: track purchase events related to Algolia requests.
• addedToCartObjectIDs: track Add to cart events not related to Algolia requests.
• convertedObjectIDs: track other conversion events not related to Algolia requests.
• sendEvents: if you don’t want to send real-time events.

Examples

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

JavaScript

// This requires the `search-insights` library

aa("purchasedObjectIDs", {
  userToken: "anonymous-123456", // required for Node.js
  authenticatedUserToken: "user-123456",
  eventName: "your_event_name",
  index: "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

eventName · string · 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 Twilio Segment’s object-action framework.

indexName · 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 · string[] · required

List of object IDs for items of an Algolia index.

You can include up to 20 object IDs.

userToken · string · required

Anonymous user identifier.

See also: User token

authenticatedUserToken · string

Pseudonymous identifier for authenticated users.

Don’t include personally identifiable information in user tokens.

See also: User token

currency · string

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.

discount · number | string

Absolute value of the discount in effect for this object, measured in currency.

Must be a decimal number with no more than 16 characters (including non-digit characters).

objectData · object[]

Extra information about the records involved in the event, for example, price and quantities of purchased products.

If provided, must be the same length as objectIDs.

If you include pricing information, you must also specify the currency parameter.

price · number | string

The price of the item. This should be the final price, inclusive of any discounts in effect.

Must be a decimal number with no more than 16 characters (including non-digit characters).

quantity · number

The quantity of the purchased or added-to-cart item. The total value of a purchase is the sum of quantity multiplied by the price of each purchased item.

value · number | string

The monetary value of the event, measured in currency. For example, the total value of a purchase.

If you assign a value, you must also specify the currency parameter.

Must be a decimal number with no more than 16 characters (including non-digit characters).