usage.md

API Usage Stats

GET /api/usage.{format}

Description

This method returns user's api usage statistics

Summary

Name	Value	Name	Value
Request Protocol	GET	Requires API Key	Yes
Method ID	1097	Enabled	Yes
Service Name	api	Service ID	223
Information Steward	UW OpenData	Data Type	Direct DB Connection
Update Frequency	Every request (live)	Cache Time	0 seconds

Notes

• Calling this method does not affect usage
• Any value can be null

Sources

• https://api.uwaterloo.ca

Parameters

GET /api/usage.{format}

Parameter	Type	Required	Description
format	input	yes	The format of the output
key	filter	yes	Your API key
callback	filter	no	JSONP callback format

Output Formats

• json
• xml

Examples

GET /api/usage.{format}

• https://api.uwaterloo.ca/v2/api/usage.json
• https://api.uwaterloo.ca/v2/api/usage.xml
• https://api.uwaterloo.ca/v2/api/usage.json?callback=myResponse

Response

Field Name	Type	Value Description
name	string	Developer's registered name
api_key	string	Developer assigned API key
monthly_calls	integer	Total calls made by the given key for the current month
total_calls	integer	Total calls made by the given key

Any value can be null

Output

JSON

{
  "meta":{
    "requests":86,
    "timestamp":1381934735,
    "status":200,
    "message":"Request successful",
    "method_id":1097,
    "version":2.07,
    "method":{
      
    }
  },
  "data":{
    "name":"Kartik Talwar",
    "api_key":"853dfe5b299a7ab7f34d6a92b233917a",
    "monthly_calls":86,
    "total_calls":62
  }
}