Signal API(en)

1. Finding Your Authentication Token

You need authentication_token to use every WalkInsights API.

See API Authentication (en) to find your authentication_token.

You have to use email and authentication_token to use WalkInsights API.

2. Using Signal API.

HTTP request format is as follows:

[headers]
x-user-email : YOUR_EMAIL
x-user-token : YOUR_AUTH_TOKEN

[URL]
GET https://dropwizard.walkinsights.com/api/v1/shops/`{shop_id}`/wifi_signals?parameters

[Parameters]
since
limit

HTTP Header

You have to provide email and authentication token generated with method guided by API Authentication (en) as http header x-user-email and x-user-token in http header.

Parameters

URL parameter shop_id is the shop id from which you want to get signals.

WalkInsights API doesn't return all signal records at once. Instead, records are paginated by certain number. Query parameter "since" and "limit" are basically similar to offset(index of first record returned) and limit(count of records) of pagination.

Parameter "since" is datetime converted to specific form(RTS) of string which signal collected since. In order to convert your datetime into RTS form, please refer to Datetime convert to rts(hex).

Parameter "limit" is number of records which the API returns at once. Defaults to be 20 and the maximum value is 200.

3. Example Signal API request and response

Click tabs to check out HTTP request and HTTP response body. Or you can try the API by yourself from Get Wifi Signals.

[Headers]
x-user-email : [email protected]
x-user-token : uS3r4uTHt0ken

[URL]
GET https://dropwizard.walkinsights.com/api/v1/shops/1234/wifi_signals?since=7fe966fdc67f7e78&limit=4

[Path Parameters]
shop_id=1234

[Query Parameters]
since=7fe966fdc67f7e78
limit=4

{
  "signals": [
    {
      "row_key": "1234:7fe966fdc4143d82",
      "device_id": "f929fbb3e8e0d007c30ca9d08d5e17ea",
      "rssi": -34,
      "square_mac": "a1b2c3d4e5f6",
      "ts": 1552901455548,
      "local": false
    },
    {
      "row_key": "1234:7fe966fdc41afeeb",
      "device_id": "e387c530b9bcc0fd5bd29f094d06f119",
      "rssi": -45,
      "square_mac": "a1b2c3d4e5f7",
      "ts": 1552901455440,
      "local": false
    },
    {
      "row_key": "1234:7fe966fdc41e2c29",
      "device_id": "e711ed57da1cb96139a457f918156ecf",
      "rssi": -26,
      "square_mac": "a1b2c3d4e5f6",
      "ts": 1552901455389,
      "local": true
    },
    {
      "row_key": "1234:7fe966fdc45a8f8c",
      "device_id": "ae9b56677797feea8f1039f3056ba2eb",
      "rssi": -61,
      "square_mac": "a1b2c3d4e5f8",
      "ts": 1552901454423,
      "local": true
    }
  ],
  "since": "7fe966fdc67f7e78"
}

Signal Schema

Name	Type	Description
row_key	String	Row key as <Shop ID>:<RTS>
device_id	String	Device MAC address from which signal is emitted.
rssi	Integer	Indicator of strength of the signal. The closer its value to 0, the stronger it is, and the closer its position from our sensor.
square_mac	String	MAC address of our sensor which collected the signal.
ts	Long Integer	When the signal collected.
local	Boolean	Whether MAC address of the device is localized or not.