v50

latestOpenAPI 3.0.3AGPLv3raw.githubusercontent.com2026-04-1028178439.6 KB
Keys

Usage Stats

Reports the number of lookups consumed on a key for a range of days.

A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval.

If no start time is provided, the start time will be set to 21 days prior to the current time.

If no end time is provided, the current time will be used.

Append tags to scope the number of lookups to those with matching tag values. E.g. tags=foo,bar will only count transactions that match foo and bar.

get/keys/{key}/usage

Path parameters

keystring required

API Key

The API Key to retrieve. Begins ak_.

Query parameters

user_tokenstring

Private User Token

A secret key used for sensitive operations on your account and API Keys.

Your user token can be retrieved and managed from your accounts page.

Typically beings uk_...

startinteger

Start Timestamp

A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556452651

endinteger

End Timestamp

An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556477882

tagsstring

** 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 multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching "foo,bar" will only query requests which tagged both "foo" and "bar".

licenseestring

Licensee Key

Uniquely identifies a licensee.

Response

Success

code2000 required
message'Success' required

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
      }
    ]
  }
}