Get usage

GEThttps://api.vidmoat.com/v1/usage

Bearer tokenScope account.readFreeTry it in the playground

Request counts (with the error split) and credits spent, for the whole account and for this key's app, for building your own dashboard or a spend alarm.

Query parameters#

daysintegerdefault 30
Window length in days, 1 to 90.

Response#

Returns 200.

Response fields#

windowobject
{ days, since }.
accountobject
{ credits, requests, errors, successes, byAction, balance } for every credential on the account. credits is net of refunds.
appobject
The same counts for this key's app (or this key, when it has no app), with appId and keyId.

Errors#

Besides the errors any request can get (authentication, rate limits):

Status	Code	When
400	`invalid_request`	`days` is not a positive number.

curl

curl "https://api.vidmoat.com/v1/usage?days=30" \
  -H "Authorization: Bearer $VIDMOAT_KEY"

Response 200

{
  "window": { "days": 30, "since": "2026-09-03T12:00:00.000Z" },
  "account": {
    "credits": 12, "requests": 340, "errors": 5, "successes": 335,
    "byAction": { "project_create": { "count": 3, "credits": 0 } },
    "balance": { "remaining": 4488, "perMonth": 6000, "resetsAt": "2026-11-01T00:00:00.000Z" }
  },
  "app": { "appId": "app_xyz", "keyId": "key_abc", "credits": 0, "requests": 120, "errors": 2, "successes": 118, "byAction": {} }
}