---
title: "Usage Dashboard"
method: GET
path: "/v1/usage"
tags: ["usage"]
---

# Usage Dashboard

`GET /v1/usage`

## Request

- Base URL: `https://api.aristocles.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.aristocles.com.au/v1/usage`
- Auth: none declared. Required headers: `X-API-Key`

Get usage dashboard for the current API key.

## Headers

- `X-API-Key` string, required

## Response `200`

Successful Response

- ApiResponseUsageDashboard
  - `data` UsageDashboard, required
    - `tier` string, required
    - `daily_limit` integer, required
    - `requests_today` integer, required
    - `remaining` integer, required
    - `endpoints` EndpointUsage[], required
      - `endpoint` string, required
      - `count` integer, required
  - `meta` Meta
    - `timestamp` string, date-time
    - `source` string
    - `version` string

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aristocles/apis/aristocles-data-api.md) · [All operations](https://skmtc.dev/aristocles/apis/aristocles-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aristocles/apis/aristocles-data-api/revisions/4ca3fbb73c59?raw)
