Returns the live API quota usage for the authenticated company
Returns the current usage and limits of the company's quota — one entry per quota window, such as per minute or per day. Every API key of the company shares this quota. Use this endpoint to self-rate-limit before issuing expensive analytics requests. Notes: - When a metric has no cap, the response returns `limit: null` and `remaining: null` so you don't divide by zero. - When the company has no quota, `quotas` is an empty list. - A single API request may count as more than one query against `max_queries_per_minute`, so the `queries` counter can climb faster than your request rate. The response includes `queries.note` to flag this when a hard limit applies. `read_bytes` reflects the actual data scanned and is the more reliable signal for sizing usage. - This endpoint itself counts as 1 query against `max_queries_per_minute`.
Authorization
apiToken apiVersion userAgent Access the application and copy your api token, then, just set the header X-Api-Token with it.
In: header
The API version to use. Currently supported versions are:
- v1: The current stable version
A request without this header, or with any other value, is answered by the edge with 404 and {"error_msg":"404 Route Not Found"}.
In: header
A non-empty User-Agent identifying your integration is required.
Requests without it are rejected at the edge before reaching the API.
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/quota/usage"{ "quotas": [ { "interval_seconds": 60, "interval_starts_at": "2026-04-27T12:34:00Z", "interval_ends_at": "2026-04-27T12:35:00Z", "queries": { "used": 20, "limit": 60, "remaining": 40, "note": "a single API request may count as more than one query against this limit" }, "read_bytes": { "used": 92535478, "limit": null, "remaining": null } }, { "interval_seconds": 86400, "interval_starts_at": "2026-04-27T00:00:00Z", "interval_ends_at": "2026-04-28T00:00:00Z", "queries": { "used": 245, "limit": null, "remaining": null }, "read_bytes": { "used": 4500000000, "limit": 343597383680, "remaining": 339097383680 } } ]}Returns the full analytics metrics for up to 2 players of an AB test POST
Returns, in a single response, the full set of analytics metrics for up to 2 players of an AB test: views, plays, finishes, clicks, conversions with revenue in USD/BRL/EUR, engagement, pitch audience and pitch retention, as well as the derived play rate, conversion rate and revenue per visitor (RPV). Each item's `start_date` is optional — when omitted, it falls back to the player's own `started_at` (from the comparison group's `players` list) and, if that is not set, to the comparison group's `started_at`. When `end_date` is omitted, results run through the current time.
Getting started
Manage VTurb videos, uploads, files, A/B tests and domains over REST