Usage report: requests and credits over time

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

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

Authorizations

x-api-keystringheaderrequired

Your API key, with the account:read scope. Authentication

Query parameters

sincestringmax 40 chars

Start, inclusive: RFC 3339 or a date (UTC), rounded down to the bucket. Default: 7 buckets before until.

untilstringmax 40 chars

End, exclusive: RFC 3339 or a date (UTC). Default: now.

bucket_widthstring

Bucket size. Default 1d. At most 168 hourly or 31 daily buckets per page.

One of1h1d

group_bystringmax 64 chars

Comma-separated subset of endpoint, api_key_id, status, surface: each bucket has one result per combination. Default: one result per bucket.

endpointstringmax 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_idstringmax 64 chars

Only this key's requests. Requests refused before any work are left out, except spend_limit_reached, which stays with its key.

includestring

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.

One oflatency_histogram

limitintegermin 1max 168

Buckets per page (default and maximum: 31 daily or 168 hourly).

cursorstringmax 200 chars

page.next_cursor of the previous page.

Response

application/json

200

Usage report: requests and credits over time

dataobject[]

This page's items.

Show 3 child fields

ending_atstring date-time

Bucket end, exclusive.

resultsobject[]

One entry per group (group_by); [] when the bucket had no requests.

Show 10 child fields

api_key_idstringnullable

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.

cache_hitsinteger

Successes served from the cache (free).

credits_chargedinteger

Credits charged.

endpointstringnullable

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.

failedinteger

Requests answered with an error (free).

latencyobjectnullable

How fast the successful requests were answered; null when none has a recorded latency (none succeeded, or all before 2026-10-31).

requestsinteger

Requests that reached an endpoint.

statusstringnullable

ok, or the error code the requests ended with; null unless grouped by status.

succeededinteger

Requests answered with data.

surfacestringnullable

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).

starting_atstring date-time

Bucket start, inclusive (RFC 3339 UTC).

metaobject

The shared route meta (see the API reference introduction).

pageobject

Show 4 child fields

end_reasonstringnullable

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.

One ofendplatform_limitmax_pages

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

400

400 Bad Request.

invalid_inputNo retry

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_cursorNo retry

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.

unauthorizedNo retry

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.

forbiddenNo retry

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. 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.

rate_limitedYes, 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 to raise the ceiling; without an API key, send one.

operationId usage.list