FastSensor PLUS Services Required
The heatmap & connected journey features are not available for every FastSensor service.
Please, contact your Account Manager for details.
Before You Begin
We strongly recommend you to review FastSensor API documentation and the examples listed in our Development Quickstart to get familiar with the API concepts and requirements.

API Endpoints

Get Heatmap

  • /locations/{location-id}/heatmap
Retrieve location's heatmap data for a period.
curl -X GET "https://api.fastsensor.us/v1/locations/{location-id}/heatmap"
Path Parameter
Description
Required
location-id
The location ID (string)
Yes
Query Parameter
Description
Required
start_date
Return results for a period starting at given a date
(date, format YYYY-MM-DD)
No
end_date
Return results for a period ending at given a date
(date, format YYYY-MM-DD)
No
aggregate
Define aggregation function (sum or average), otherwise list all items
(string, enum [sum, avg])
No
hour_details
List details per hour (boolean)
No
RESPONSE:
  • Status: 200 - OK
{
    "data": [
        {
            "date": Date (string, date, format YYYY-MM-DD),
            "position": [
                {
                    "count": Daily counter for that position (number),
                    "area": Name of the area that piont belongs to (string),
                    "details": Position coordinates (string),
                    "returning": Number of returning visitors, subset of visitors (number)
              "hour_details": [
                  {
                      "hour": Hour (00-23) (number),
                      "count": Hourly counter  (number)
                  }
              ]
                }
            ]
        }
    ]
}
For position, details format is "[Floor Plan Image File ID]*[x coordinate]*[y coordinate]". Use x and y coordinates to plot breadcrumbs on the floor plan image.
  • Status: 401 - Access token is missing or invalid

Get Interactions (Connected Journey)

  • /locations/{location-id}/interactions
Retrieve visitors interactions (connected journey) for a period.
curl -X GET "https://api.fastsensor.us/v1/locations/{location-id}/interactions"
Path Parameter
Description
Required
location-id
The location ID (string)
Yes
Query Parameter
Description
Required
start_date
Return results for a period starting at given a date
(date, format YYYY-MM-DD)
No
end_date
Return results for a period ending at given a date
(date, format YYYY-MM-DD)
No
RESPONSE:
  • Status: 200 - OK
{
    "data": [
     [
      [
              {Origin Area (string)},
              {Destination Area (string)},
              {Count (number)},
      ]
     ]
    ]
}
The data is a two-dimension array representing the origin-destination (OD) data at each level of interaction. The first dimension is the interaction level, and the second is the OD data for each area and the number of occurrences.
  • Status: 401 - Access token is missing or invalid

Next steps: