# Usage report: requests and credits over time

Account

GET `/v1/usage`

Requests, successes, failures, cache hits, credits charged and the latency of successful requests (p50, p95, and a histogram on request) per time bucket, optionally grouped by endpoint, key, outcome and surface (REST, MCP or a job). Buckets are listed oldest first, cursor-paged. Data is complete to within about 5 minutes; credits reconcile with the ledger. Requests refused before any work (a 402 or 429 with no charge, or while the API was paused) count per account, outcome and surface only: grouped by endpoint or key they have null there, and filtering by endpoint or key leaves them out. spend_limit_reached alone also stays with its key. Free.

**Auth:** an API key with the `account:read` scope, or the dashboard session.

## Example

cURL:

```shell
curl 'https://socialtap.dev/v1/usage' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

## Authorizations

`x-api-key`stringheaderrequired

Your API key, with the `account:read` scope. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `since` optional | `string`<br>max 40 chars | Start, inclusive: RFC 3339 or a date (UTC), rounded down to the bucket. Default: 7 buckets before until. | — |
| `until` optional | `string`<br>max 40 chars | End, exclusive: RFC 3339 or a date (UTC). Default: now. | — |
| `bucket_width` optional | `string` | Bucket size. Default 1d. At most 168 hourly or 31 daily buckets per page.<br>One of `1h`, `1d` | — |
| `group_by` optional | `string`<br>max 64 chars | Comma-separated subset of endpoint, api_key_id, status, surface: each bucket has one result per combination. Default: one result per bucket. | — |
| `endpoint` optional | `string`<br>max 100 chars | Only this endpoint ID (youtube.transcript). Requests refused before any work are left out: they have no endpoint (see Endpoint in the results). | — |
| `api_key_id` optional | `string`<br>max 64 chars | Only this key's requests. Requests refused before any work are left out, except spend_limit_reached, which stays with its key. | — |
| `include` optional | `string` | latency_histogram: add each result's latency.histogram (null otherwise), to merge results yourself. Ask for it with the fewest groups you need: it adds up to 26 entries per result.<br>One of `latency_histogram` | — |
| `limit` optional | `integer`<br>min 1<br>max 168 | Buckets per page (default and maximum: 31 daily or 168 hourly). | — |
| `cursor` optional | `string`<br>max 200 chars | page.next_cursor of the previous page. | — |

## Response

### 200

Usage report: requests and credits over time

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object[]` | This page's items. |
| `data[].ending_at` | `string` (date-time) | Bucket end, exclusive. |
| `data[].results` | `object[]` | One entry per group (group_by); \[\] when the bucket had no requests. |
| `data[].results[].api_key_id` | `string` or `null` | Key ID; null unless grouped by api_key_id, and for requests refused before any work (a 402 or 429 with no charge, or while the API was paused), which count per account; spend_limit_reached keeps its key. |
| `data[].results[].cache_hits` | `integer` | Successes served from the cache (free). |
| `data[].results[].credits_charged` | `integer` | Credits charged. |
| `data[].results[].endpoint` | `string` or `null` | Endpoint ID; null unless grouped by endpoint, and for requests refused before any work (a 402 or 429 with no charge, or while the API was paused), which count per account. |
| `data[].results[].failed` | `integer` | Requests answered with an error (free). |
| `data[].results[].latency` | `object` or `null` | How fast the successful requests were answered; null when none has a recorded latency (none succeeded, or all before 2026-10-31). |
| `data[].results[].requests` | `integer` | Requests that reached an endpoint. |
| `data[].results[].status` | `string` or `null` | ok, or the error code the requests ended with; null unless grouped by status. |
| `data[].results[].succeeded` | `integer` | Requests answered with data. |
| `data[].results[].surface` | `string` or `null` | How the requests reached the API: the surface of their request log entries (GET /v1/requests). null unless grouped by surface, and for requests made before surfaces were counted (2026-10-31). |
| `data[].starting_at` | `string` (date-time) | Bucket start, inclusive (RFC 3339 UTC). |
| `meta` | `object` | The shared route meta (see the API reference introduction). |
| `page` | `object` |  |
| `page.end_reason` | `string` or `null` | Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.<br>One of `end`, `platform_limit`, `max_pages` |
| `page.has_more` | `boolean` | True when another page exists; then next_cursor is set. An empty page with has_more true is not the end. |
| `page.next_cursor` | `string` or `null` | Pass as cursor, with the same other parameters, to get the next page; null at the end. |
| `page.next_cursor_expires_at` | `string` (date-time) or `null` | When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors. |

### 400

400 Bad Request.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |
| `invalid_cursor` | 400 | No | The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it. | Repeat the original request without cursor to start the list again. |

### 401

401 Unauthorized.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 403

403 Forbidden.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |

### 429

429 Too Many Requests.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

operationId `usage.list`

---

[HTML version](https://socialtap.dev/docs/reference/account/usage-list/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)