GET /foot-traffic/locations

Get Foot Traffic from all locations

This endpoint returns data aggregated by location. The results returned from this endpoint can be used to gain insight into individual locations or to compare locations against each other.

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. Returned data is aggregated by location so that one result is returned for each interval of time at each location. The interval can be one of: 15m, hour, day, week, month, year. For example, if the hour interval is used, a result will be returned for each hour and location in the requested range. If your team has two locations and requested 24 hours worth of hour intervals, a total of 48 (2 x 24) Location Metrics would be returned.

Get Foot Traffic at location level

get

https://api.getdor.com/dtm-api/v1https://api-staging.getdor.com/dtm-api/v1

/foot-traffic/locations

Get Foot Traffic at location level

Authorizations

basic_auth

AuthorizationstringRequired

Query parameters

datetime_startstringOptional

The start date

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

datetime_endstringOptional

The end date

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

limitnumberOptional

The query limit

location_idsstringOptional

The location ids to be filtered (array of string IDs)

intervalstring · enumRequired

The foot-traffic interval

Possible values:

Responses

200

Successful operation

application/json

400

Invalid parameters

404

Device not found

get

/foot-traffic/locations

HTTPcURLJavaScriptPython

GET /dtm-api/v1/foot-traffic/locations?interval=15m HTTP/1.1
Host: api.getdor.com
Authorization: Basic username:password
Accept: */*

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