---
title: "Get API usage & credit consumption"
method: GET
path: "/api/v1/account/credits/usage"
tags: ["Account Management"]
---

# Get API usage & credit consumption

`GET /api/v1/account/credits/usage`

## Request

- Base URL: `https://api.rodz.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.rodz.io/api/v1/account/credits/usage`
- Auth: HTTP bearer

See exactly which API calls are consuming your credits, so you can pinpoint the integration or workflow that's spending the most and dial it back.

**Input:** `from`/`to` (ISO-8601 timestamps; default is the last 7 days), an optional `endpoint` to filter to a single route (e.g. `/v4/firmographic`), `interval` (`hour` or `day`, default `hour`) controlling the time-series bucket size, and `limit`/`offset` (default 100 / 0) to page through the individual-call log.

**Output:** `totalCalls` and `totalCredits` for the window; `byEndpoint` — a per-route rollup sorted by spend, so you can see which route costs the most; `timeSeries` — calls and credits per hour or day, to spot exactly when a spike began; and `calls` — a paginated log of individual billed calls (timestamp, route, credits) for a precise per-call, per-time-range, per-route view.

## Query parameters

- `from` string, date-time, nullable: Window start (ISO-8601). Defaults to 7 days ago.
- `to` string, date-time, nullable: Window end (ISO-8601). Defaults to now.
- `endpoint` string, nullable: Filter to a single route, e.g. /v4/firmographic.
- `interval` string: Time-series bucket size: hour or day.
- `limit` integer: Max individual calls to return (pagination).
- `offset` integer: Offset into the individual-call log.

## Response `200`

Successful Response

- object: Billable API-call usage for your account over a time window.
  - `fromDate` string, date-time, required: Start of the window (UTC).
  - `toDate` string, date-time, required: End of the window (UTC).
  - `totalCalls` integer, required: Total billed calls in the window (after any route filter).
  - `totalCredits` number, required: Total credits consumed in the window (after any route filter).
  - `byEndpoint` object[]: Per-route rollup, highest spend first.
    - `endpoint` string, required: The API route that was called.
    - `calls` integer, required: Number of billed calls to this route in the window.
    - `credits` number, required: Credits consumed by this route in the window.
  - `timeSeries` object[]: Usage per time bucket (hour or day), oldest first.
    - `bucket` string, date-time, required: Start of the time bucket (UTC).
    - `calls` integer, required: Billed calls in this bucket.
    - `credits` number, required: Credits consumed in this bucket.
  - `calls` object[]: Individual billed calls, newest first (paginated via limit/offset).
    - `timestamp` string, date-time, required: When the call was billed (UTC).
    - `endpoint` string, required: The API route that was called.
    - `credits` number, required: Credits charged for this call.
  - `hasMore` boolean: True if more calls exist beyond this page.

## Other responses

- `422`: Validation Error
- `429`: Rate limit exceeded. Retry after the number of seconds in the `Retry-After` response header.

---

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