IPera Starling | Developer Hub

# Guest Dashboard

# Get Guests

By using this API endpoint, it is possible to get the guest statistics hourly, daily or monthly.

Notes:

  • Endpoint returns unique guest counts in each date group.
  • 'Sum' key returns total unique guest count in given date interval.

Response will change based on the range between start and end date parameters.

  • If the range is one day, it’ll return hourly data
  • If the range is less than a month, it’ll show daily data
  • If the range is more than a month it’ll show monthly data

# Endpoint

GET /reports/dashboard/guests

# Parameters

Name Type Required Description
location_id string Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned
start_date datetime ✔ Start date (format: yyyy-mm-dd hh:mm:ss)
end_date datetime ✔ End date (format: yyyy-mm-dd hh:mm:ss)

# Response

TIP

HTTP/1.1 200 OK

# Hourly Response
{
    "data": {
        "2020-06-01 00:00": 10,
        "2020-06-01 01:00": 10,
        "2020-06-01 02:00": 10,
        "2020-06-01 03:00": 10,
        "2020-06-01 04:00": 10,
        "2020-06-01 05:00": 10,
        "2020-06-01 06:00": 10,
        "2020-06-01 07:00": 10,
        "2020-06-01 08:00": 10,
        "2020-06-01 09:00": 10,
        "2020-06-01 10:00": 10,
        "2020-06-01 11:00": 10,
        "2020-06-01 12:00": 10,
        "2020-06-01 13:00": 10,
        "2020-06-01 14:00": 10,
        "2020-06-01 15:00": 10,
        "2020-06-01 16:00": 10,
        "2020-06-01 17:00": 10,
        "2020-06-01 18:00": 10,
        "2020-06-01 19:00": 10,
        "2020-06-01 20:00": 10,
        "2020-06-01 21:00": 10,
        "2020-06-01 22:00": 10,
        "2020-06-01 23:00": 10
    },
    "meta": {
        "group": "hourly"
    },
    "sum": 240
}
# Daily Response
{
    "data": {
        "2020-06-01": 10,
        "2020-06-02": 10,
        "2020-06-03": 10,
        "2020-06-04": 10,
        "2020-06-05": 10,
        "2020-06-06": 10,
        "2020-06-07": 10,
        "2020-06-08": 10,
        "2020-06-09": 10,
        "2020-06-10": 10,
        "2020-06-11": 10,
        "2020-06-12": 10,
        "2020-06-13": 10,
        "2020-06-14": 10,
        "2020-06-15": 10,
        "2020-06-16": 10,
        "2020-06-17": 10,
        "2020-06-18": 10,
        "2020-06-19": 10
    },
    "meta": {
        "group": "daily"
    },
    "sum": 190
}
# Monthly Response
{
 "data": {
       "2020-01-01": 10,
       "2020-02-01": 10,
       "2020-03-01": 10,
       "2020-04-01": 10,
       "2020-05-01": 10,
       "2020-06-01": 10,
       "2020-07-01": 10,
       "2020-08-01": 10,
       "2020-09-01": 10,
       "2020-10-01": 10,
       "2020-11-01": 10,
       "2020-12-01": 10
   },
   "meta": {
       "group": "monthly"
   },
   "sum": 120
}

Unprocessible Entity

HTTP/1.1 422 Unprocessible Entity

{
    "message": "The given data was invalid.",
    "errors": {
        "start_date": [
            "The start date field is required."
        ],
        "end_date": [
            "The end date field is required."
        ]
    }
}

# Get New Guests

By using this API endpoint, it is possible to get the new guest statistics hourly, daily or monthly.

Notes:

  • Endpoint returns unique guest counts in each date group.
  • 'Sum' key returns total unique guest count in given date interval.

Response will change based on the range between start and end date parameters.

  • If the range is one day, it’ll return hourly data
  • If the range is less than a month, it’ll show daily data
  • If the range is more than a month it’ll show monthly data

# Endpoint

GET /reports/dashboard/new-guests

# Parameters

Name Type Required Description
location_id string Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned
start_date datetime ✔ Start date (format: yyyy-mm-dd hh:mm:ss)
end_date datetime ✔ End date (format: yyyy-mm-dd hh:mm:ss)

# Response

TIP

HTTP/1.1 200 OK

# Hourly Response
{
    "data": {
        "2020-06-01 00:00": 10,
        "2020-06-01 01:00": 10,
        "2020-06-01 02:00": 10,
        "2020-06-01 03:00": 10,
        "2020-06-01 04:00": 10,
        "2020-06-01 05:00": 10,
        "2020-06-01 06:00": 10,
        "2020-06-01 07:00": 10,
        "2020-06-01 08:00": 10,
        "2020-06-01 09:00": 10,
        "2020-06-01 10:00": 10,
        "2020-06-01 11:00": 10,
        "2020-06-01 12:00": 10,
        "2020-06-01 13:00": 10,
        "2020-06-01 14:00": 10,
        "2020-06-01 15:00": 10,
        "2020-06-01 16:00": 10,
        "2020-06-01 17:00": 10,
        "2020-06-01 18:00": 10,
        "2020-06-01 19:00": 10,
        "2020-06-01 20:00": 10,
        "2020-06-01 21:00": 10,
        "2020-06-01 22:00": 10,
        "2020-06-01 23:00": 10
    },
    "meta": {
        "group": "hourly"
    },
    "sum": 240
}
# Daily Response
{
    "data": {
        "2020-06-01": 10,
        "2020-06-02": 10,
        "2020-06-03": 10,
        "2020-06-04": 10,
        "2020-06-05": 10,
        "2020-06-06": 10,
        "2020-06-07": 10,
        "2020-06-08": 10,
        "2020-06-09": 10,
        "2020-06-10": 10,
        "2020-06-11": 10,
        "2020-06-12": 10,
        "2020-06-13": 10,
        "2020-06-14": 10,
        "2020-06-15": 10,
        "2020-06-16": 10,
        "2020-06-17": 10,
        "2020-06-18": 10,
        "2020-06-19": 10
    },
    "meta": {
        "group": "daily"
    },
    "sum": 190
}
# Monthly Response
{
 "data": {
       "2020-01-01": 10,
       "2020-02-01": 10,
       "2020-03-01": 10,
       "2020-04-01": 10,
       "2020-05-01": 10,
       "2020-06-01": 10,
       "2020-07-01": 10,
       "2020-08-01": 10,
       "2020-09-01": 10,
       "2020-10-01": 10,
       "2020-11-01": 10,
       "2020-12-01": 10
   },
   "meta": {
       "group": "monthly"
   },
   "sum": 120
}

Unprocessible Entity

HTTP/1.1 422 Unprocessible Entity

{
    "message": "The given data was invalid.",
    "errors": {
        "start_date": [
            "The start date field is required."
        ],
        "end_date": [
            "The end date field is required."
        ]
    }
}

# Get Guest Connections

By using this API endpoint, it is possible to get the guest connection statistics hourly, daily or monthly.

Response will change based on the range between start and end date parameters.

  • If the range is one day, it’ll return hourly data
  • If the range is less than a month, it’ll show daily data
  • If the range is more than a month it’ll show monthly data

# Endpoint

GET /reports/dashboard/guest-connections

# Parameters

Name Type Required Description
location_id string Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned
start_date datetime ✔ Start date (format: yyyy-mm-dd hh:mm:ss)
end_date datetime ✔ End date (format: yyyy-mm-dd hh:mm:ss)

# Response

TIP

HTTP/1.1 200 OK

# Hourly Response
{
    "data": {
        "2020-06-01 00:00": 10,
        "2020-06-01 01:00": 10,
        "2020-06-01 02:00": 10,
        "2020-06-01 03:00": 10,
        "2020-06-01 04:00": 10,
        "2020-06-01 05:00": 10,
        "2020-06-01 06:00": 10,
        "2020-06-01 07:00": 10,
        "2020-06-01 08:00": 10,
        "2020-06-01 09:00": 10,
        "2020-06-01 10:00": 10,
        "2020-06-01 11:00": 10,
        "2020-06-01 12:00": 10,
        "2020-06-01 13:00": 10,
        "2020-06-01 14:00": 10,
        "2020-06-01 15:00": 10,
        "2020-06-01 16:00": 10,
        "2020-06-01 17:00": 10,
        "2020-06-01 18:00": 10,
        "2020-06-01 19:00": 10,
        "2020-06-01 20:00": 10,
        "2020-06-01 21:00": 10,
        "2020-06-01 22:00": 10,
        "2020-06-01 23:00": 10
    },
    "meta": {
        "group": "hourly"
    },
    "sum": 240
}
# Daily Response
{
    "data": {
        "2020-06-01": 10,
        "2020-06-02": 10,
        "2020-06-03": 10,
        "2020-06-04": 10,
        "2020-06-05": 10,
        "2020-06-06": 10,
        "2020-06-07": 10,
        "2020-06-08": 10,
        "2020-06-09": 10,
        "2020-06-10": 10,
        "2020-06-11": 10,
        "2020-06-12": 10,
        "2020-06-13": 10,
        "2020-06-14": 10,
        "2020-06-15": 10,
        "2020-06-16": 10,
        "2020-06-17": 10,
        "2020-06-18": 10,
        "2020-06-19": 10
    },
    "meta": {
        "group": "daily"
    },
    "sum": 190
}
# Monthly Response
{
 "data": {
       "2020-01-01": 10,
       "2020-02-01": 10,
       "2020-03-01": 10,
       "2020-04-01": 10,
       "2020-05-01": 10,
       "2020-06-01": 10,
       "2020-07-01": 10,
       "2020-08-01": 10,
       "2020-09-01": 10,
       "2020-10-01": 10,
       "2020-11-01": 10,
       "2020-12-01": 10
   },
   "meta": {
       "group": "monthly"
   },
   "sum": 120
}

Unprocessible Entity

HTTP/1.1 422 Unprocessible Entity

{
    "message": "The given data was invalid.",
    "errors": {
        "start_date": [
            "The start date field is required."
        ],
        "end_date": [
            "The end date field is required."
        ]
    }
}

# Get Guest Traffics

By using this API endpoint, it is possible to get the guest traffic statistics in bytes hourly, daily or monthly.

Response will change based on the range between start and end date parameters.

  • If the range is one day, it’ll return hourly data
  • If the range is less than a month, it’ll show daily data
  • If the range is more than a month it’ll show monthly data

# Endpoint

GET /reports/dashboard/guest-traffics

# Parameters

Name Type Required Description
location_id string Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned
start_date datetime ✔ Start date (format: yyyy-mm-dd hh:mm:ss)
end_date datetime ✔ End date (format: yyyy-mm-dd hh:mm:ss)

# Response

TIP

HTTP/1.1 200 OK

# Hourly Response
{
    "data": {
        "2020-06-01 00:00": 1024,
        "2020-06-01 01:00": 1024,
        "2020-06-01 02:00": 1024,
        "2020-06-01 03:00": 1024,
        "2020-06-01 04:00": 1024,
        "2020-06-01 05:00": 1024,
        "2020-06-01 06:00": 1024,
        "2020-06-01 07:00": 1024,
        "2020-06-01 08:00": 1024,
        "2020-06-01 09:00": 1024,
        "2020-06-01 10:00": 1024,
        "2020-06-01 11:00": 1024,
        "2020-06-01 12:00": 1024,
        "2020-06-01 13:00": 1024,
        "2020-06-01 14:00": 1024,
        "2020-06-01 15:00": 1024,
        "2020-06-01 16:00": 1024,
        "2020-06-01 17:00": 1024,
        "2020-06-01 18:00": 1024,
        "2020-06-01 19:00": 1024,
        "2020-06-01 20:00": 1024,
        "2020-06-01 21:00": 1024,
        "2020-06-01 22:00": 1024,
        "2020-06-01 23:00": 1024
    },
    "meta": {
        "group": "hourly"
    },
    "sum": 24576
}
# Daily Response
{
    "data": {
        "2020-06-01": 1024,
        "2020-06-02": 1024,
        "2020-06-03": 1024,
        "2020-06-04": 1024,
        "2020-06-05": 1024,
        "2020-06-06": 1024,
        "2020-06-07": 1024,
        "2020-06-08": 1024,
        "2020-06-09": 1024,
        "2020-06-10": 1024,
        "2020-06-11": 2048,
        "2020-06-12": 2048,
        "2020-06-13": 2048,
        "2020-06-14": 2048,
        "2020-06-15": 2048,
        "2020-06-16": 2048,
        "2020-06-17": 2048,
        "2020-06-18": 2048,
        "2020-06-19": 2048
    },
    "meta": {
        "group": "daily"
    },
    "sum": 38912
}
# Monthly Response
{
 "data": {
       "2020-01-01": 1024,
       "2020-02-01": 1024,
       "2020-03-01": 1024,
       "2020-04-01": 1024,
       "2020-05-01": 1024,
       "2020-06-01": 1024,
       "2020-07-01": 1024,
       "2020-08-01": 1024,
       "2020-09-01": 1024,
       "2020-10-01": 1024,
       "2020-11-01": 1024,
       "2020-12-01": 1024
   },
   "meta": {
       "group": "monthly"
   },
   "sum": 12288
}

Unprocessible Entity

HTTP/1.1 422 Unprocessible Entity

{
    "message": "The given data was invalid.",
    "errors": {
        "start_date": [
            "The start date field is required."
        ],
        "end_date": [
            "The end date field is required."
        ]
    }
}
Last Updated: 5/5/2022, 8:39:21 PM

← Guest Devices →