Send events

Sends a list of events to the Insights API.

You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.

Authorizations

x-algolia-application-id

string

headerrequired

Your Algolia application ID.

x-algolia-api-key

string

headerrequired

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Body

application/json

events

object[]

required

Click and conversion events.

All events must be valid, otherwise the API returns an error.

• Clicked object IDs after search
• Added to cart object IDs after search
• Purchased object IDs after search
• Converted object IDs after search
• Clicked object IDs
• Purchased object IDs
• Added to cart object IDs
• Converted object IDs
• Clicked filters
• Converted filters
• Viewed object IDs
• Viewed filters

Show child attributes

events.eventName

string

required

Event name, up to 64 ASCII characters.

Consider naming events consistently—for example, by adopting Segment's object-action framework.

Required string length: 1 - 64

events.eventType

enum<string>

required

Available options:

click

events.index

string

required

Index name (case-sensitive) to which the event's items belong.

events.objectIDs

string[]

required

Object IDs of the records that are part of the event.

events.positions

integer[]

required

Position of the clicked item the search results.

You must provide 1 position for each objectID.

events.queryID

string

required

Unique identifier for a search query.

The query ID is required for events related to search or browse requests. If you add clickAnalytics: true as a search request parameter, the query ID is included in the API response.

Required string length: 32

events.userToken

string

required

Anonymous or pseudonymous user identifier.

Don't use personally identifiable information in user tokens. For more information, see User token.

Required string length: 1 - 129

events.authenticatedUserToken

string

Identifier for authenticated users.

When the user signs in, you can get an identifier from your system and send it as authenticatedUserToken. This lets you keep using the userToken from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see User token.

Required string length: 1 - 129

events.timestamp

integer

Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.

Response

200 - application/json

The response of the Insights API.

message

string

Details about the response, such as error messages.

status

integer

The HTTP status code of the response.