Guest Devices

Get Guest Devices

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

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

Endpoint

GET /guest-devices

Rate Limit

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

Parameters

Name	Type	Description
guest_id	string	End-user ID
mac	string	Guest device MAC address
online	boolean	If the guest device is currently online or not. true / false
created_at	date	Returns entries created after the entered date (format: yyyy-mm-dd)
updated_at	date	Returns entries updated after the entered date (format: yyyy-mm-dd)
yas_id	string	Yas ID
last_guest_device_first	boolean	List most recent devices first. true/false
per_page	integer	The number of records returned. Default is 10, maximum is 100

Response

TIP

HTTP/1.1 200 OK

{
  "data": [
    {
      "id": "ApR3zO7zqeZ",
      "guest_id": "NgqovXZLDOy",
      "yas_id": "8f627d10-1abc-44d8-b964-a7816388173a",
      "type_name": "Desktop",
      "mac": "f4:5c:89:94:d4:2b",
      "ip": "95.6.16.57",
      "user_agent": null,
      "description": "Macintosh",
      "platform": "OS X",
      "browser": "Mozilla",
      "connection_status": "Offline",
      "connection_status_value": 0,
      "total_downloaded_data": "1.64 GB",
      "total_uploaded_data": "141.72 MB",
      "last_seen_time": "2017-02-14T10:27:46+00:00",
      "created_at": "2017-01-04T11:41:29+00:00",      
      "updated_at": "2017-02-14T10:46:46+00:00"
    }
  ],

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

  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "[[BaseUrl]]/guests-devices",
    "per_page": 10,
    "to": 2
  }
}

Get Guest Device Count

By using this API endpoint, it is possible to get the count of the guest devices.

Endpoint

GET /guest-devices/count

Rate Limit

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

Parameters

Name	Type	Description
guest_id	string	End-user ID
mac	string	Guest device MAC address
online	boolean	If the guest device is currently online or not. true / false
created_at	date	Returns count of the entries created after the entered date (format: yyyy-mm-dd)
updated_at	date	Returns count of the entries updated after the entered date (format: yyyy-mm-dd)
yas_id	string	Yas ID

Response

TIP

HTTP/1.1 200 OK

{
  "count": 1000
}