API Reference

Accoil exposes two APIs that serve different purposes:

Ingress API -- send user, account, and event data into Accoil for processing.
Accounts API -- read engagement metrics, scores, and insights back out of Accoil.

Ingress API

The Ingress API accepts identify, group, and track calls. All requests are sent to:

https://in.accoil.com

All ingress requests are processed asynchronously and return 202 Accepted.

v2 endpoints (recommended): Include your API key in the Authorization header using Basic authentication:

Authorization: Basic YOUR_API_KEY

v1 endpoints (legacy): Include your API key in the request body as the api_key field.

Your Ingress API key is found in the Accoil dashboard under Account > General settings. Each product has its own key.

Endpoint	Description
POST /v2/identify	Identify a user and set their traits
POST /v2/group	Associate a user with an account and set account traits
POST /v2/track	Record a user event

Legacy v1 endpoints are also available under Legacy (v1).

The Accounts API lets you retrieve engagement data from Accoil. All requests are sent to:

https://api.accoil.com

Include your API token in the Authorization header using Bearer authentication:

Authorization: Bearer accoil_YOUR_API_TOKEN

Your Accounts API token is found in the Accoil dashboard under Settings > Product Settings > API Token.

Endpoint	Description
GET /v1/accounts	Retrieve engagement metrics and insights for a customer account