Usage

Retrieve API usage by day.

The examples use IDs from a sample sandbox. Your sandbox has the same people, calendars and events with its own IDs, which GET /v2/sandbox returns. When you're signed in to the dashboard, Try it fills in your IDs and sends the request to your sandbox, never to live data.

GET/v2/usage

Get usage by day

Returns your organization's requests per day on v1, v2 and test keys, the share of requests made to v2, and the busiest endpoints. Usage is counted every 10 seconds, so today's figures can be up to 10 seconds behind.

Sends the request to your sandbox, never to live data.

Query parameters

Name
from
Type
string (date)
Description
The first day (UTC), such as 2026-10-01.
Name
to
Type
string (date)
Description
The last day (UTC), such as 2026-10-01.
Name
appId
Type
string
Description
Returns usage for this app only.

Errors

VALIDATION_INVALID_QUERY (400): A query parameter is not valid.
AUTH_INVALID_KEY (401): The API key is missing, unknown or revoked.
AUTH_EXPIRED_KEY (401): The API key has expired.
AUTH_INSUFFICIENT_SCOPE (403): The API key or session does not have permission to make this request.
RATE_LIMIT_EXCEEDED (429): The request rate exceeds this plan's rate limit.
RATE_LIMIT_BURST (429): Too many requests were sent in a short period.
INTERNAL_ERROR (500): Something went wrong on our end.

Request

GET

/v2/usage

curl 'https://api.pyas.io/v2/usage' \  -H "x-api-key: $PYAS_API_KEY"

Response

200 OK

{  "success": true,  "data": {    "totals": {      "v1": 0,      "v2": 0,      "test": 0    },    "v2Share": null,    "days": [],    "topEndpoints": []  },  "provider": null,  "traceId": "trc_5f2a9c1e7b3d4a6f8e0c2b1d",  "meta": {    "from": "2026-10-16",    "to": "2026-11-14"  }}