Send events

Sends a list of events to the Insights API.

POST /1/events

curl

cURL

curl --request POST \
  --url https://insights.us.algolia.io/1/events \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '
{
  "events": [
    {
      "eventName": "Products Clicked",
      "eventType": "click",
      "index": "test-index",
      "userToken": "anonymous-user-1",
      "authenticatedUserToken": "user-1",
      "objectIDs": [
        "object-1"
      ],
      "positions": [
        1
      ],
      "queryID": "7dfe2ada7bca48bdd0629649df0bee07"
    }
  ]
}
'

200

Success

{
  "status": 200,
  "message": "OK"
}

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

Required ACL: search

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

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 · (Clicked object IDs after search · object | Added to cart object IDs after search · object | Purchased object IDs after search · object | Converted object IDs after search · object | Clicked object IDs · object | Purchased object IDs · object | Added to cart object IDs · object | Converted object IDs · object | Clicked filters · object | Converted filters · object | Viewed object IDs · object | Viewed filters · object)[] · required

Click and conversion events.

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

Required array length: 1 - 1000 elements

Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event.

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

Response

200

application/json

OK

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.