What fields are required for Segment?

When you send events from Segment to Algolia, the Algolia destination expects a few additional fields that aren’t part of the standard Segment event schema.

At a minimum, the Algolia destination requires:

• index – the name of the Algolia index

• eventType – one of view, click, or conversion

Depending on the type of event you’re sending and which Algolia features you’re using, you may also need to include some of these optional fields:

• queryID – to link the event back to a specific search

• objectIDs – for events that act on specific records (for example, click or conversion on items)

• positions – positions of the clicked items in the search results

• filters – for events that operate on facet filters instead of individual records

For example, when you send a click event based on individual items, you must include the objectIDs field so Algolia knows which records the event refers to.