Usage Stats
Reports the number of lookups a key consumed over a date range, as a total and a daily breakdown.
The range defaults to the last 21 days. start and end take UNIX timestamps in milliseconds, and end defaults to the current time. The maximum range is 90 days.
Query at most three tags at once.
Request
- Base URL: https://api.addresszen.com/v1
- URL: https://api.addresszen.com/v1/keys/{key}/usage
- Auth: HTTP bearer
Path parameters
API Key
The API Key to retrieve. Begins ak_.
Query parameters
Management Key
A secret key used to manage your account and API Keys. It was previously called the user token.
Your management key can be retrieved and managed from your accounts page.
Typically begins uk_.... Prefer the Authorization: Bearer uk_... header.
Start Timestamp
A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556452651
End Timestamp
An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556477882
Tags
A comma separated list of tags to query over.
Useful if you want to specify the circumstances in which the request was made.
If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".
Licensee Key
Uniquely identifies a licensee.
Response
Success
Example response
{
"result": {
"start": "2015-01-22T15:08:06.609Z",
"end": "2015-01-23T15:08:06.609Z",
"total": 132,
"dailyCount": [
{
"date": "2015-01-22T00:00:00.000Z",
"count": 132
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.