Credits

Get usage statistics

Retrieve credit usage statistics for a specified timeframe

get/api/credits/usage-stats

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/credits/usage-stats
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

timeframe'24h' | '7d' | '30d'
Example:30d

Timeframe for statistics (24h, 7d, or 30d)

Response

Usage statistics retrieved successfully

timeframestring required

The timeframe for the statistics

totalSpentinteger required

Total credits spent in the timeframe

totalEarnedinteger required

Total credits earned in the timeframe

totalRefundedinteger required

Total credits refunded in the timeframe

Example response

{
  "timeframe": "30d",
  "totalSpent": 500,
  "totalEarned": 1000,
  "totalRefunded": 50,
  "dailyUsage": [
    {
      "date": "2025-01-15",
      "spent": 100
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.