Flow Data Collection 🚶

Introduction

Below is a quick and straightforward overview for collecting flow data. For more information, access the API Documentation.

Base URL:

https://api.painelalter.com/api/

All requests start with this base URL, and the route is appended at the end.

Example:

https://api.painelalter.com/api/v2/count
https://api.painelalter.com/api/v2/countAdjusted

Authentication

To use the API, you must include an authorization header using Basic authentication. This means providing your username and password in all requests.

Example

Using Postman, select Authorization → Basic Auth and enter your credentials.

Endpoints

/count

This endpoint returns foot traffic data ordered by devices, considering the selected date range. It shows exactly the data captured by the devices, without adjustments.

/countAdjusted

This endpoint returns adjusted foot traffic data, including corrections based on availability. We recommend using this data for reports and analysis.

Query Parameters

Parameter	Description
dateBegin	Start date. Format YYYY-MM-DD (Inclusive)
dateEnd	End date. Format YYYY-MM-DD (Inclusive)
eventType	ID of the event type to be retrieved (1 = entry flow)
groupBy	Data grouping parameter

Event Type IDs Table

EventType	Description
1	Entry Flow
2	Exit Flow
3	Checkout Stop
4	External Flow Left
5	External Flow Right
6	Employee Entry
7	Employee Exit
8	Vehicle Entry
9	Vehicle Exit
10	In-store Flow
11	Group Entry

groupBy Values Table

groupBy	Description
day	Group by day
month	Group by month
hour	Group by hour
weekday	Group by day of the week
day-hour	Group by day and hour