Usage Stats

GET 
/keys/:key/usage

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.

Request

Path Parameters

key API Keyrequired

Query Parameters

start int32

A start date/time in the form of a UNIX Timestamp in milliseconds, e.g. 1418556452651. If no start time is provided, the start time will be assigned to a time 21 days prior to the end time.

end int32

An end date/time in the form of a UNIX Timestamp in milliseconds, e.g. 1418556452651. If no end time is provided, the current time will be used.

tags Tags
licensee Licensee Key

Sublicensed keys only. This will restrict the analysed dataset to a specific licensee.

Responses

200

Success

application/json

Schema

Schema

result objectrequired
start stringrequired
Start date in ISO 8601 format.
end stringrequired
End date in ISO 8601 format.
total int32required
Total of paid lookups performed in specified period.
dailyCount object[]required
An array of objects representing number of paid lookups made on specific days, ordered by date. Each object contains a date attribute, which represents the day and a count attribute, which represents the number of paid lookups made on that day.
Array [
date stringrequired
count int32required
]
code int32required

Possible values: [2000]

message stringrequired

Possible values: [Success]

Example (from schema)

{
  "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
      }
    ]
  },
  "code": 2000,
  "message": "Success"
}

400

Bad Request

application/json

Schema

Schema

code int32required

API Response Code. Non 2xxx code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging.

message stringrequired

Human readable error message supplied with every error response.

errors object[]
Array [
message stringrequired
Indicates location of error in request query or URL parameter
path stringrequired
Indicates location of error in request query or URL parameter
errorCode string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    {
      "message": "should have required property 'type'",
      "path": ".query.type",
      "errorCode": "required.openapi.validation"
    }
  ]
}

Loading...