Guest Activities

Get Guest Activities

By using this API endpoint, it is possible to get the list of guest activities.

Please note that you cannot get more than 1000 records per request. In case you need to get more than 1000 records, then you should make more than one request.

Please note that API returns response as default 1 day range, maximum 1 week range.

Endpoint

GET /guests/activities

Rate Limit

This endpoint has a rate limit of 20 requests per minute.

Parameters

Name	Type	Description
guest_id	string	End-user ID
location_id	string	Location / Venue ID
activity_type	integer	Activity type: 1: Impression - seen splash page (welcome page) 2: Connected - signed in 5: Disconnected - signed out
created_at	date	Returns entries created after the specified date up to 1 week later (format: yyyy-mm-dd)
start_time	datetime	Returns entries started after the entered starting date (about 1 week after created_at) (format: yyyy-mm-dd hh:mm:ss)
end_time	datetime	Returns entries ended before the entered ending date (about 1 week after created_at) (format: yyyy-mm-dd hh:mm:ss)
per_page	integer	The number of records returned. Default is 10, maximum is 1000

Response

Tips

HTTP/1.1 200 OK

{
  "data": [
    {
      "activity_name": "Connected",
      "activity_type": 2,
      "created_at": "2017-10-27T12:13:01+00:00",
      "guest_id": "X392YKaq6Dg",
      "location_id": "pqn2Kek6MO5",
      "location_name": "IPERA New York",
      "yas_id": "8f627d10-1abc-44d8-b964-a7816388173a"
    },
    {
      "activity_name": "Disconnected",
      "activity_type": 5,
      "created_at": "2017-10-27T12:04:40+00:00",
      "guest_id": "1XQLlBBGo4j",
      "location_id": "pqn2Kek6MO5",
      "location_name": "IPERA New York",
      "yas_id": "d4399948-05e7-4efa-91fb-39198515f308"
    },
    {
      "activity_name": "Impression",
      "activity_type": 1,
      "created_at": "2017-10-27T11:43:46+00:00",
      "guest_id": "9xko9aPOo7a",
      "location_id": "pqn2Kek6MO5",
      "location_name": "IPERA New York",
      "yas_id": "ea28901d-35fc-4e37-aeb4-b3a4cb2a180b"
    }
  ],

  "links": {
    "first": "[[BaseUrl]]/guests/activities?page=1",
    "last": null,
    "next": "[[BaseUrl]]/guests/activities?page=2",
    "prev": null
  },

  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "[[BaseUrl]]/guests/activities",
    "per_page": 15,
    "to": 3
  }
}