Description
Returns the current status of API usage for the account associated with the api_key.
This resource is not available to free 30-day developer plans. However, postal code history is available. Please contact sales@weathersource.com if you need access to this resource.
Resource URL
https://api.weathersource.com/v1/:api_key/account/usage.format
Resource URL Replacement Parts
| {{api_key}} | Your API Key. If you do not have an API key, you may sign up for a free developer account 30-day trial. |
|---|---|
| {{format}} | The desired response format. Allowed formats are:
|
Parameters
| timestamp_eq optional |
A response condition that returns a single element matching a timestamp. Timestamp values must be provided in ISO 8601 format. If the timezone offset portion of the timestamp is not provided, it will be assumed to be +00:00 (UTC). The returned timestamp may not equal the provided value, but will be representative of the value. For example, if the period parameter is set to day and the provided timestamp will be for that day, but not for the specific time within that day. If the minute period is requested, timestamp_eq will be forced to the current time. The default value of the current time will only be applied if the timestamp_between parameter is not provided. Allowed Values: ISO 8601 timestamp Default Value: current time Example Value: 2004-02-12T08:00:00-08:00 |
|---|---|
| timestamp_between optional |
A response condition that returns the subset of elements with a timestamp with a day equal to or between those provided. Timestamp values must be provided in ISO 8601 format. If the timezone offset portion of the timestamp is not provided, it will be assumed to be +00:00 (UTC). This parameter is not avilable for the minute period. Allowed Values: Two comma separated ISO 8601 timestamps Example Value: 2004-02-10T08:00:00-08:00,2004-02-12T08:00:00-08:00 |
| period optional |
Identifies the period of time to group API request counts. For the day period, the day is always the UTC day (from midnight to midnight with a +00:00 UTC offset). Only the current minute is available for the minute period. Allowed Values: minute, day Default Value: day |
| limit optional |
Specifies the quantity of elements to retrieve. Allowed Values: Integers between 1 and 25 Default Value: 5 |
| offset optional |
Specifies the first element to retrieve (index starts at 0). Allowed Values: Integers greater than or equal to 0 Default Value: 0 |
| fields optional |
Set response to a subset of fields within each element. The requests field will always be returned, even if omitted. Available field names: Minute specific fields (period parameter is set to minute): Day specific fields (period parameter is set to day): Allowed Values: Comma separated list of field names Default Value: all fields |
Resource Information
| API Versions | v1 |
|---|---|
| Rate Limited? | No |
| Requires Authentication? | Yes |
| Response Formats | JSON JSONP CSV |
| HTTP Method | GET |
Example Request
GET https://api.weathersource.com/v1/{api_key}/account/usage.json?period=day
[{"key":"{api_key}","timestamp":"2013-02-25T00:00:00+00:00","requests":86,"throttled_minutes":0}]
