DTM docs
HomeDor Traffic MinerMetagraphDTM AppMarketingAPI
API
API
  • Overview
  • Authentication
    • Basic Auth
    • Manually Creating Basic Auth Headers
  • Response Format
    • Successful Responses
    • Error Responses
  • Pagination
  • Datetimes
    • Datetime Formats
    • Datetimes Grouped by Local Time Zone
  • Rate Limiting
  • Syncing Data
    • Asynchronous Data
    • Querying by Update Timestamp
  • Data Validity
    • Validity
    • Completeness
  • Endpoints
    • Organizations
      • GET /organizations
      • GET /organizations/{org_id}
    • Locations
      • GET /locations
      • GET /locations/{location_id}
      • GET /locations/{location_id}/devices
      • POST /locations
      • DELETE /locations/{location_id}
    • Devices
      • GET /devices
      • GET /devices/{serial_number}
      • PUT /devices/{serial_number}
      • POST /devices/{serial_number}/install
      • POST /devices/{serial_number}/uninstall
      • GET /uninstalled-devices
    • Foot Traffic
      • GET /foot-traffic/locations
      • GET /foot-traffic/devices/{serial_number}
    • Schemas
      • Organization
      • Location
      • Address
      • Device
      • LocationMetric
      • Foot Traffic
Powered by GitBook
On this page
  1. Endpoints
  2. Foot Traffic

GET /foot-traffic/devices/{serial_number}

Get Foot Traffic at device level

PreviousGET /foot-traffic/locationsNextSchemas

Last updated 1 year ago

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 . Data is returned for each interval time at each device. The interval can be one of: 15m, hour, day, week, month, year.

grouped by local timezone

Get Foot Traffic at device level

get

Get Foot Traffic at device level

Authorizations
Path parameters
serial_numberstringRequired

The serial_number

Example: AA000000
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_idsstring[]Optional

The location ids to be filtered

intervalstring ยท enumRequired

The foot-traffic interval

Possible values:
Responses
200
Successful operation
application/json
400
Invalid parameters
404
Device not found
get
GET /dtm-api/v1/foot-traffic/devices/{serial_number} 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",
      "foot_traffic": {
        "in_count": 10,
        "out_count": 10,
        "count": 10,
        "validity": "valid",
        "completeness": "complete"
      }
    }
  ],
  "meta": {
    "limit": 50,
    "next": "https://test.test/endpoint?next=2lkj23jf2fljf29"
  }
}