HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get loyalty indicator aggregate values

(Deprecated, API will not be supported from release 2.5.4). Retrieves aggregate value of loyalty indicators i.e. unique visitors, new visitors and loyalty visitors for each store of a customer or site. The response contains loyalty indicators of all time intervals between start time & stop time. It provides the baseline value for selected time frame.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

loyalty state with values unique, new, loyal. Default is all

Allowed:
string

id of label/site/Campus/Building/floor

int64
required

start time in epoch

int64
required

stop time in epoch

Responses

400

A required parameter or field is missing

401

Unauthorized access. Authentication failed or was not provided.

403

Access denied

404

The requested entity was not found

413

Request-size limit exceeded

417

Request-size limit exceeded

429

You do not have permissions to use this API

500

There is an internal error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json