GET /foot-traffic/devices/{serial_number}

Get Foot Traffic at device level

This endpoint returns data for a specific device.

You can query the results by the datetime_start (inclusive) and datetime_end (exclusive) parameters can be used to query for data recorded within the specified datetime range. Note that these parameters are grouped by local timezone. Data is returned for each interval time at each device. The interval can be one of: 15m, hour, day, week, month, year.

Get Foot Traffic at device level

Get Foot Traffic at device level

get

/foot-traffic/devices/{serial_number}

Authorizations

Path parameters

serial_numberstringrequired

The serial_number

Example: AA000000

Query parameters

datetime_startstring

The start date

Example: 2021-10-10T00:00:00Z

datetime_endstring

The end date

Example: 2021-10-10T00:00:00Z

limitnumber

The query limit

location_idsstring[]

The location ids to be filtered

intervalstring · enumrequired

The foot-traffic interval

Options: 15m, hour, day, week, month, year

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getdor.com/dtm-api/v1/foot-traffic/devices/{serial_number}?interval=15m' \
  --header 'Authorization: Basic username:password'

200

400

404

200

{
  "data": [
    {
      "datetime_start": "2023-01-01T00:00:00",
      "datetime_end": "2023-01-01T00:00:00",
      "interval": "day",
      "foot_traffic": {
        "in_count": 10,
        "out_count": 10,
        "count": 10,
        "validity": "valid",
        "completeness": "complete"
      }
    }
  ],
  "meta": {
    "limit": 50,
    "next": "https://test.test/endpoint?next=2lkj23jf2fljf29"
  }
}

Successful operation