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

# Usage

`GET /usage`

## Request

- Base URL: `https://api.mixrank.com/v2/json/YOUR_API_KEY`
- URL: `https://api.mixrank.com/v2/json/YOUR_API_KEY/usage`
- Auth: none declared

Account-wide API usage for the current month or a specified month.

Usage covers all users in your account. `details` is null when no usage rows are available. An invalid month returns HTTP 200 with an `errors.month` message. `details[].api_key` contains API credentials. Quantities use each billing category's unit; they are not universally bytes or HTTP request counts.

## Query parameters

- `month` string

## Response `200`

Successful response.

- union
  - object
    - `account_name` string, nullable, required: Your account name.
    - `total_events` integer, nullable, required: Total billing events, not a count of all HTTP requests.
    - `total_data_quantity` integer, nullable, required: Amount of data items returned by API queries.
    - `details` object[], nullable, required: API query and data item count, broken down by category.
      - `category` string, nullable: Billing category.
      - `email` string, nullable: Account user associated with the usage.
      - `api_key` string, nullable: An active API key for that user.
      - `quantity` integer, nullable: Billed data quantity for this category and user.
      - `events` integer, nullable: Billing event count for this category and user.
  - object
    - `errors` object, required
      - `month` string

## Other responses

- `403`: Invalid key or insufficient endpoint permissions.
- `404`: No matching object or results.
- `408`: The database query timed out.
- `429`: Concurrent request limit exceeded.
- `500`: Internal API error.

---

[API](https://skmtc.dev/mixrank/apis/mixrank-api.md) - [All operations](https://skmtc.dev/mixrank/apis/mixrank-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mixrank/apis/mixrank-api/revisions/786d3fcfe918?raw)
