Session API

始める前に

WalkInsightsのSession APIを利用する場合、通常は以下のようなAPIを使います。

https://api.walkinsights.com/api/v1/shops/{shop_id}/wifi_sessions

上のAPIでWalk Insightsが提供する全てのAPIがご利用できます。
(この文書は最下にあるリンクをご参考ください)

** もしSession APIのみのご使用の場合はこの文書の内容をご参考ください。

❗️
注意
この文書はSession APIのみをご使用する時に使用できます。
Walk Insightsの全てのREST APIはサポートしていません。

新しい方法でSession APIを利用する

上記でお話ししましたWalkInsights Session APIの使い方は以下のようになります。

[headers]
X-User-Email : YOUR_EMAIL
X-User-Token : YOUR_AUTHENTICATION_TOKEN

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

[Parameters]
since
limit

Parameterの説明は以下になります。

Parameter	Type	Require	Default Value	Example
since	String	No		since=7feb6e7a8886cb4d:in
limit	String	No	20(max: 200)	limit=20

上記のようにリクエストをすると以下のようなレスポンスが返却されます。

{
  since: "7feb6e7a8886cb4d:in",
  sessions: [
    {
      row_key: "1:7feb0c09745c236b:in",
      wifi_id: "b83b0d11462a6fe84057f4c1a26225ce",
      dwell_time: 5,
      area: "out",
      ts: 1435897485000,
      local: true,
      revisit_count: null,
      revisit_period: null,
      deny: null
    },
    {
      row_key: "1:7feb0c09745c236b:in",
      wifi_id: "d53a92482b683ed83de306653854d978",
      dwell_time: 5,
      area: "in",
      ts: 1433318231031,
      local: false,
      revisit_count: 1,
      revisit_period: 15,
      deny: true
    },
    ...
  ]
}

レスポンスの結果のJSONは上記のようになります。
以下は各値の説明になります。

Name	Type	Description
since	String	Offset
sessions	Array	Sessionの集合
row_key	String	Sessionのunique key
wifi_id	String	SessionのWIFI ID
dwell_time	Integer	Sessionの滞在時間
area	String	Sessionのエリア名前
ts	Integer	UNIX Epoch TimeStamp
local	Boolean	Sessionのローカライズ
revisit_count	Integer	Sessionの再訪問回数
revisit_period	Double	Sessionsの再訪問周期
deny	Boolean	Sessionのdeny可否

🚧
REST API認証について
この文書では認証の関しての説明はありません。
認証の情報が必要な場合、最下にあるAPI認証文書のリンクによりご確認ください。

sinceの活用法

Session APIでoffsetのsinceを活用する仕組みを確認しましょう。

レスポンスで返却されたJSONデータの中でsessionsの最後のobjectを利用します。

sessionsの最新順で整列されていますので

最初のobjectは最新のsessionデータであり

最後にあるobjectはsession中でもっとも古いsessionデータです。

ですので最後のobjectを利用すると前日のsessionsを確認できます。

仕組みは以下のようになります。

  json = Json.parse(response.body)

  since = json.get("since")

これで確認できたsinceでSession APIをリクエストするparameterとして挿入すると終わりです。

https://dropwizard.walkinsights.com/api/v1/shops/{shop_id}/wifi_sessions?since=since