This guide explains how to retrieve store data using the Flow Reporting API.
The API provides:
Traffic (by entrance)
Demographics (age and gender)
Sales
Transactions
Items sold
The data follows the same logic as the Flow platform and can be used directly for reporting purposes.
Current endpoint: /kpis/hourly
Returns hourly traffic, demographics, and sales data.
Additional endpoints may be introduced following the same structure.
If you require a different data structure or additional APIs, please contact:
[email protected]
To retrieve data:
Get API key
https://app.flow-insight.com/general
Settings > General > Integrations > Flow API
Obtain store codes
Provided by Flow
Send request
POST https://reporting-api.flow-insight.com/rest/kpis/hourly
Receive response and process data
This is sufficient to begin integration.
Headers:
Content-Type: application/json
X-Secret-Key: {your-api-key}
Accept-Language: en curl -X POST https://reporting-api.flow-insight.com/rest/kpis/hourly \
-H "Content-Type: application/json" \
-H "X-Secret-Key: {your-api-key}" \
-H "Accept-Language: en" \
-d '{
"date": "2026-04-19",
"storeCodes": ["101", "102"]
}'{
"data": [
{
"storeCode": "101",
"timestamp": "2026-04-19T11:00:00",
"traffic": {
"001": { "enters": 37, "exits": 47 }
},
"demographics": {
"group_2": 11,
"group_6": 50
},
"sales": 51854,
"transactions": 12,
"itemSold": 22
}
],
"status": 200
}Field | Description |
|---|---|
storeCode | Unique store identifier assigned by Flow |
timestamp | Start time of the hour (Example: 11:00:00 → data for 11:00–11:59) |
traffic | Traffic counts per entrance or sensor
Keys such as "001", "002" represent individual entrances or sensors. These identifiers are managed by Flow and may not correspond to named entrances known by the client. Important: to calculate total store traffic, sum the enters values across all entrances. |
demographics | Estimated counts by age and gender:
Fields may be omitted if values are zero or not detected. |
sales | Total sales amount |
transactions | Number of transactions |
itemSold | Number of items sold |
Store codes are unique identifiers managed by Flow.
They cannot be created or modified by the client.
Store codes correspond directly to the store identifiers assigned to each location within the Flow platform.
Maximum 20 stores per request
If more than 20 stores are required, split requests accordingly
Limitations:
The * wildcard cannot be used
Store codes must be explicitly specified
Data is updated continuously during store operation
The latest hour may still be updating
Use end-of-day data for finalized reporting
Historical data is available via the API
The API provides data at an hourly level.
Daily data is calculated by summing hourly values
Monthly data is calculated by summing daily values
Aggregation must be handled on the client side.
Hourly data is typically used for:
Time-of-day performance analysis
Identifying peak hours
Staffing optimization
Daily data is typically used for:
Reporting and KPI tracking
Performance summaries
Monthly analysis
200: Success
401: Authentication error
Check:
API key
Request format
Email: [email protected]
URL: https://app.flow-insight.com/general