---
title: "Usage Stats"
method: GET
path: "/keys/{key}/usage"
tags: ["Keys"]
---

# Usage Stats

`GET /keys/{key}/usage`

## Request

- Base URL: `https://api.addresszen.com/v1`
- URL: `https://api.addresszen.com/v1/keys/{key}/usage`
- Auth: HTTP bearer

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.

## Path parameters

- `key` string, required

## Query parameters

- `user_token` string
- `start` integer
- `end` integer
- `tags` string
- `licensee` string

## Response `200`

Success

- ApiKeyUsageResponse
  - `result` KeyUsageResult, required
    - `start` string, required: Start date in ISO 8601 format.
    - `end` string, required: End date in ISO 8601 format.
    - `total` integer, required: 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.
      - `date` string, required
      - `count` integer, required
  - `code` 2000, required
  - `message` 'Success', required

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/addresszen/apis/api-reference.md) · [All operations](https://skmtc.dev/addresszen/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/addresszen/apis/api-reference/revisions/cac119db15c0?raw)