# Usage report: requests and credits over time

Account

GET `/v1/usage`

Requests, successes, failures, cache hits and credits charged per time bucket, optionally grouped by endpoint, key and outcome. Buckets are listed oldest first, cursor-paged. Data is complete to within about 5 minutes; credits reconcile with the ledger. Free.

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

**Test mode:** A test key gets an empty report: test requests are not metered.

## Example

cURL:

```shell
curl 'https://staging.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://staging.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: 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). | — |
| `api_key_id` optional | `string`<br>max 64 chars | Only this key's requests. | — |
| `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. |
| `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. |
| `data[].results[].failed` | `integer` | Requests answered with an error (free). |
| `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[].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 | The request parameters are missing or malformed, or the URL is not a supported link for this endpoint. | Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names. |
| `invalid_cursor` | 400 | No | The cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued 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, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired). | Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_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: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way 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): branch on the code. | Do what details.reason says: if suspended, contact [support](https://staging.socialtap.dev/docs/index.md); otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP. |

### 429

429 Too Many Requests.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead. | Wait for the number of seconds in the retry-after header, then retry; ask [support](https://staging.socialtap.dev/docs/index.md) to raise the ceiling if your sustained traffic needs more (calls without an API key: use one). |

## Test mode

A test key gets an empty report: test requests are not metered.

operationId `usage.list`

---

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