Usage

Usage statistics and billing endpoints

Get current usage

get

https://api.visobird.comhttp://localhost:3000

/api/v1/usage

Get current usage statistics and billing information

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer vb_your_api_key_here

Responses

200

Current usage statistics

application/json

401

Authentication required or invalid API key

application/json

get

/api/v1/usage

HTTPcURLJavaScriptPython

GET /api/v1/usage HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPeriod": {
    "startDate": "2025-12-15T18:06:20.411Z",
    "endDate": "2025-12-15T18:06:20.411Z",
    "requestsUsed": 1,
    "requestsLimit": 1,
    "percentage": 1
  },
  "plan": {
    "name": "text",
    "price": 1,
    "currency": "text",
    "billingCycle": "monthly"
  },
  "nextBilling": "2025-12-15T18:06:20.411Z"
}

Get usage history

get

https://api.visobird.comhttp://localhost:3000

/api/v1/usage/history

Get historical usage data

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header:

Authorization: Bearer vb_your_api_key_here

Query parameters

periodstring · enumOptional

Time period for aggregation

Default: monthlyPossible values:

limitinteger · min: 1 · max: 100Optional

Number of periods to return

Default: 12

Responses

200

Historical usage data

application/json

401

Authentication required or invalid API key

application/json

get

/api/v1/usage/history

HTTPcURLJavaScriptPython

GET /api/v1/usage/history HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "monthlyUsage": [
    {
      "period": "text",
      "requests": 1,
      "successRate": 1,
      "avgProcessingTime": 1
    }
  ],
  "totalRequests": 1,
  "avgSuccessRate": 1
}