historical_usage_building.md

Historical wireless building usage statistics

GET /wireless/historical/usage/{building_code}.{format}

Description

This method returns historical wireless usage statistics for the requested building.

Summary

Name	Value	Name	Value
Request Protocol	GET	Requires API Key	Yes
Method ID	10006	Enabled	Yes
Service Name	wireless	Service ID	1000
Information Steward	Information Systems & Technology	Data Type	Database
Update Frequency	Every 15 minutes	Cache Time	0 seconds

Notes

• Historical data is only available for the past 2 months
• Any value can be null

Sources

• https://uwaterloo.ca/information-systems-technology/statistics/wifi-charts

Parameters

GET /wireless/historical/usage/{building_code}.{format}

Parameter	Type	Required	Description
key	filter	yes	Valid API key
callback	filter	no	JSONP callback format
from	filter	yes	Timestamp of start time (in ISO 8601 format)
to	filter	yes	Timestamp of end time (in ISO 8601 format)

Output Formats

• json
• xml

Examples

GET /wireless/historical/usage/{building_code}.{format}

• https://api.uwaterloo.ca/v2/wireless/historical/usage/MC.json?from=2017-06-28T160000-0400&to=2017-06-28T161500-0400
• https://api.uwaterloo.ca/v2/wireless/historical/usage/MC.xml
• https://api.uwaterloo.ca/v2/wireless/historical/usage/MC.json?callback=myResponse

Response

Field Name	Type	Value Description
building_code	string	Building code
clients	string	Number of wireless clients
rates	object	Current usage rates download integer Curent download rate, in bps upload integer Current upload rate, in bps
last_updated	string	Timestamp of collection

Any value can be null

Output

JSON

{
    "meta": {
        "requests": 1016650,
        "timestamp": 1501171207,
        "status": 200,
        "message": "Request successful",
        "method_id": 10006,
        "method": []
    },
    "data": [
        {
            "building_code": "MC",
            "clients": 1210,
            "rates": {
                "download": 143013023,
                "upload": 15099758
            },
            "last_updated": "2017-06-28T16:00:00-04:00"
        },
        {
            "building_code": "MC",
            "clients": 1167,
            "rates": {
                "download": 148025373,
                "upload": 16182193
            },
            "last_updated": "2017-06-28T16:15:00-04:00"
        }
    ]
}