Retrieve usage numbers

GET

keys.getVerifications

curl --request GET \
  --url https://api.unkey.dev/v1/keys.getVerifications \
  --header 'Authorization: Bearer <token>'

{
  "verifications": [
    {
      "time": 1620000000000,
      "success": 100,
      "rateLimited": 10,
      "usageExceeded": 123
    }
  ]
}

Changelog

Date	Changes
Jan 08 2024	Introduced endpoint

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

keyId

string

The id of the key to fetch, either keyId or ownerId must be provided

ownerId

string

The owner id to fetch keys for, either keyId or ownerId must be provided

start

integer | null

The start of the period to fetch usage for as unix milliseconds timestamp

end

integer | null

The end of the period to fetch usage for as unix milliseconds timestamp

granularity

enum<string>

default: day

The granularity of the usage data to fetch, currently only day is supported

Available options:

day

200 - application/json

verifications

object[]

required

Was this page helpful?

curl --request GET \
  --url https://api.unkey.dev/v1/keys.getVerifications \
  --header 'Authorization: Bearer <token>'

{
  "verifications": [
    {
      "time": 1620000000000,
      "success": 100,
      "rateLimited": 10,
      "usageExceeded": 123
    }
  ]
}