The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content
API docs by Redocly

Insights API (1.0.0)

Download OpenAPI specification:Download

API powering the Insights feature of Algolia.

Events

Events operations.

Push events

This command pushes an array of events.

An event is

  • an action: eventName
  • performed in a context: eventType
  • at some point in time provided: timestamp
  • by an end user: userToken
  • on something: index

Notes:

  • To be accepted, all events sent must be valid.
  • The size of the body must be less than 2 MB.
  • When an event is tied to an Algolia search, it must also provide a queryID. If that event is a click, their absolute positions should also be passed.
  • We consider that an index provides access to 2 resources: objects and filters. An event can only interact with a single resource type, but not necessarily on a single item. As such an event will accept an array of objectIDs or filters.
Authorizations:
(appIdapiKey)
Request Body schema: application/json
required
Array of objects (InsightEvent) [ items <= 1000 ]

Array of events sent.

Array
eventType
required
string (eventType)
Enum: "click" "conversion" "view"
eventName
required
string <= 64

A user-defined string used to categorize events.

index
required
string

Name of the targeted index.

userToken
required
string[a-zA-Z0-9_-=/+]{1,128}

A user identifier. Depending if the user is logged-in or not, several strategies can be used from a sessionId to a technical identifier. You should always send pseudonymous or anonymous userTokens.

timestamp
integer <int64>

Time of the event expressed in milliseconds since the Unix epoch.

queryID
string

Algolia queryID. This is required when an event is tied to a search.

objectIDs
Array of strings

An array of index objectID. Limited to 20 objects. An event can’t have both objectIDs and filters at the same time.

filters
Array of strings

An array of filters. Limited to 10 filters. An event can’t have both objectIDs and filters at the same time.

positions
Array of integers

Position of the click in the list of Algolia search results. This field is required if a queryID is provided. One position must be provided for each objectID.

Responses

Request samples

Content type
application/json
{
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}