HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get presence analytics metrics aggregate values

(Deprecated, API will not be supported from release 2.5.4). Retrieves presence stats i.e. aggregated/average values, up_down rates , and baseline values for presence indicators (passerby, visitor, drawrate, dwelltime). The response contains all below values and consider all time intervals between start time & stop time for calculating results.
Contains aggregated value of classification states ( passerby and visitor ). aggregate value is total value of all time intervals between start time & stop time.
Contains average value of draw rate (conversion rate from passerby to visitor) and dwell time ( total time of all visitors, divided by visitors count ).
Contains delta rate (either positive or negative) compare to baseline for all presence indicator fields ( passerBy , visitor, draw rate, dwell time).
Contains baseline value for each presence indicator which is ideal value for that metric in selected time period.

Query Params
string
enum

category with values passerby , visitor, drawrate, dwelltime. 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
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json