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 Tags

  • /locations/{location-id}/tags
Retrieve the list of tags (badges and wearables).
curl -X GET "https://api.fastsensor.us/v1/locations/{location-id}/tags"
Path Parameter
Description
Required
location-id
The location ID (string)
Yes
RESPONSE:
  • Status: 200 - OK
{
    "data": [
        {
            "tag_id": Tag ID or MAC address (string),
            "active": (boolean)
        }
    ]
}
  • Status: 401 - Access token is missing or invalid

Get XY Coordinates

  • /locations/{location-id}/xy
curl -X GET "https://api.fastsensor.us/v1/locations/location-id/xy?start_time=&end_time=&selector="
Path Parameter
Description
Required
location-id
The location ID (string)
Yes
Query Parameter
Description
Required
start_time
Return results for a period starting at a given time
(number, epoch time in seconds)
No
end_time
Return results for a period ending at a given time
(number, epoch time in seconds)
No
selector
Filter by tag ID (string, "[" + tag ID + "]")
No
Selector
CURL requires to use URL encoded form for the selector. For example, the string "[f090a826f2a3]", shall be encoded as "%5Bf090a826f2a3%5D".
RESPONSE:
  • Status: 200 - OK
{
    "data": [
        {
            "timestamp": Timestamp (number, epoch time in seconds),
            "tag_id": Tag ID (string),
            "details": Additional information (string)
        }
    ]
}
For XY 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
Note:
Each request is limited to 24 hours of data, and the response will include the first 5,000 data points.

Sample Data

Find below XY coordinates sample data:
{
    "meta": {
        "code": 200
    },
    "description": {
        "object":"position",
        "api_version":"2020-02-01",
        "created":1589326679,
        "has_more":false,
        "start_date":"2020-05-01",
        "end_date":"2020-05-02",
        "selector":"[f090a826f2a3]"
    },
    "data": [
        {
            "timestamp":1588367580,
            "tag_id":"f090a826f2a3",
            "details":"25224E04*380*210"
        },
        {
            "timestamp":1588437540,
            "tag_id":"f090a826f2a3",
            "details":"25224E04*485*205"
        },
        {
            "timestamp":1588438020,
            "tag_id":"f090a826f2a3",
            "details":"25224E04*190*225"
        },
        {
            "timestamp":1588441140,
            "tag_id":"f090a826f2a3",
            "details":"25224E04*245*275"
        },
        {
            "timestamp":1588456380,
            "tag_id":"f090a826f2a3",
            "details":"25224E04*340*270"
        },
        {
            "timestamp":1588464840,
            "tag_id":"f090a826f2a3",
            "details":"25224E04*410*225"
        }
    ]
}

Next steps: