시작하기

Realtime API를 사용하면 매장, 혹은 센서 단위로 체류객의 실시간 수를 쿼리할 수 있습니다. 이 API를 사용하면 조회 시점으로부터 10분 전까지의 중복되지 않는 WiFi 디바이스 수를 확인할 수 있습니다.

필요 사항

인증

Realtime API를 사용하기 위해서는 API 인증이 필요합니다. API 인증에서 자세한 내용을 확인할 수 있습니다.

현재 시점으로부터 체류객의 수 확인하기

Realtime API를 사용하여 매장이나 센서에 인식된, 중복되지 않은 WiFi 디바이스의 실시간 수를 확인할 수 있습니다. Realtime API에서 쿼리 되는 데이터셋은 센서에서 신호 데이터가 수집됨과 동시에 자동으로 처리되어 저장되며, 2초 간격으로 생성된 것입니다.

Realtime 요청은 다음 형식의 HTTP URL입니다.

📘
https://api.walkinsights.com/api/v1/shops/:shop_id/realtime/:area?parameters

여기서 area는 다음 값 중 하나입니다.

in은 실내 체류객('in'으로 설정 된 영역에서 감지 된 디바이스)의 수를 나타냅니다.
out은 실외 유동인구('out'으로 설정 된 영역에서 감지 된 디바이스)의 수를 나타냅니다.

Realtime API 요청을 시작하기 위해서는 특정 매개변수가 필요합니다. URL 표준 형식과 마찬가지로, 모든 매개변수는 앰퍼샌드(&) 문자를 사용하여 구분합니다.

필수 매개변수

이 API는 필수 매개변수가 필요하지 않습니다.

선택적 매개변수

limit - 조회 할 데이터셋의 개수를 지정합니다.

Realtime API 요청 예시

다음은 574번 매장에서 현재 실시간 통행객 데이터를 시간 역순으로 10건 조회하는 예시입니다.

https://api.walkinsights.com/api/v1/shops/574/realtime/out?limit=10

요청에 대한 응답은 요청 응답 섹션을 참고하시기 바랍니다.

요청 응답

다음 예시는 위의 요청 예시에 대한 응답 데이터입니다.

{
  "values": [
    {
      "expires_at": 1506502922000,
      "key": "shop:574:in",
      "time": 1506502322000,
      "value": 27
    },
    {
      "expires_at": 1506502920000,
      "key": "shop:574:in",
      "time": 1506502320000,
      "value": 36
    },
    {
      "expires_at": 1506502918000,
      "key": "shop:574:in",
      "time": 1506502318000,
      "value": 39
    },
    {
      "expires_at": 1506502916000,
      "key": "shop:574:in",
      "time": 1506502316000,
      "value": 39
    },
    {
      "expires_at": 1506502914000,
      "key": "shop:574:in",
      "time": 1506502314000,
      "value": 39
    },
    {
      "expires_at": 1506502912000,
      "key": "shop:574:in",
      "time": 1506502312000,
      "value": 40
    },
    {
      "expires_at": 1506502910000,
      "key": "shop:574:in",
      "time": 1506502310000,
      "value": 40
    },
    {
      "expires_at": 1506502908000,
      "key": "shop:574:in",
      "time": 1506502308000,
      "value": 39
    },
    {
      "expires_at": 1506502906000,
      "key": "shop:574:in",
      "time": 1506502306000,
      "value": 39
    },
    {
      "expires_at": 1506502904000,
      "key": "shop:574:in",
      "time": 1506502304000,
      "value": 34
    }
  ],
  "next": 1506502302000
}

Realtime API는 최대 두 개의 루트 요소를 포함합니다.

values - 시간별 데이터셋의 리스트입니다. 각각의 데이터셋은 아래와 같은 요소를 포함하고 있습니다.
expires_at - 이 데이터셋이 자동으로 삭제될 시점을 나타내는 Unix Timestamp 값입니다. 단위는 밀리세컨드입니다.
key - 이 데이터셋의 버킷을 나타냅니다. 내부적으로 사용되는 값입니다.
time - 데이터셋이 생성된 시점을 나타내는 Unix Timestamp 값입니다. 단위는 밀리세컨드입니다.
value - 중복되지 않는 WiFi 디바이스의 수를 나타냅니다.
next - 마지막 데이터셋 바로 다음에 시작 될 데이터셋의 time 값입니다.