GET
/
usage
Get usage statistics
curl --request GET \
  --url https://api.vidnavigator.com/v1/usage \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "data": {
    "usage_period": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    },
    "billing_period": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "interval": "month"
    },
    "subscription": {
      "plan_id": "<string>",
      "plan_name": "<string>",
      "interval": "month",
      "status": "<string>",
      "cancel_at_period_end": true
    },
    "usage": {
      "video_transcripts": {
        "used": 123,
        "limit": 123,
        "remaining": 123,
        "percentage": 123,
        "unit": "<string>"
      },
      "video_searches": {
        "used": 123,
        "limit": 123,
        "remaining": 123,
        "percentage": 123,
        "unit": "<string>"
      },
      "video_analyses": {
        "used": 123,
        "limit": 123,
        "remaining": 123,
        "percentage": 123,
        "unit": "<string>"
      },
      "video_scene_analyses": {
        "used": 123,
        "limit": 123,
        "remaining": 123,
        "percentage": 123,
        "unit": "<string>"
      },
      "youtube_channels_scans": {
        "used": 123,
        "limit": 123,
        "remaining": 123,
        "percentage": 123,
        "unit": "<string>"
      },
      "video_uploads": {
        "used": 123,
        "limit": 123,
        "remaining": 123,
        "percentage": 123,
        "unit": "<string>"
      }
    },
    "storage": {
      "used_bytes": 123,
      "used_formatted": "<string>",
      "limit_bytes": 123,
      "limit_formatted": "<string>",
      "remaining_bytes": 123,
      "remaining_formatted": "<string>",
      "percentage": 123
    },
    "generated_at": "2023-11-07T05:31:56Z"
  }
}
Retrieve your current API usage, including request counts for different endpoints and storage information.

​
Overview

This endpoint provides a snapshot of your current usage statistics, which is useful for monitoring your consumption and managing your limits.

​
Example Request

cURL
curl "https://api.vidnavigator.com/v1/usage" \
  -H "X-API-Key: YOUR_API_KEY"

​
Success Response (200 OK)

Returns an object containing detailed usage statistics for your account, broken down by service and storage. 
{
  "status": "success",
  "data": {
    "usage_period": {
      "start": "2023-10-01T00:00:00Z",
      "end": "2023-11-01T00:00:00Z"
    },
    "billing_period": {
      "start": "2023-10-15T00:00:00Z",
      "end": "2023-11-15T00:00:00Z",
      "interval": "month"
    },
    "subscription": {
      "plan_id": "pro",
      "plan_name": "Pro Plan",
      "interval": "month",
      "status": "active",
      "cancel_at_period_end": false
    },
    "usage": {
      "video_transcripts": {
        "used": 150,
        "limit": 1000,
        "remaining": 850,
        "percentage": 15,
        "unit": "requests"
      },
      "video_searches": {
        "used": 300,
        "limit": 5000,
        "remaining": 4700,
        "percentage": 6,
        "unit": "requests"
      },
      "video_analyses": {
        "used": 75,
        "limit": "unlimited",
        "remaining": "unlimited",
        "percentage": 0,
        "unit": "requests"
      },
      "video_scene_analyses": {
        "used": 50,
        "limit": 200,
        "remaining": 150,
        "percentage": 25,
        "unit": "requests"
      },
      "youtube_channels_scans": {
        "used": 5,
        "limit": 10,
        "remaining": 5,
        "percentage": 50,
        "unit": "requests"
      },
      "video_uploads": {
        "used": 20,
        "limit": 100,
        "remaining": 80,
        "percentage": 20,
        "unit": "requests"
      }
    },
    "storage": {
      "used_bytes": 2684354560,
      "used_formatted": "2.5 GB",
      "limit_bytes": 10737418240,
      "limit_formatted": "10 GB",
      "remaining_bytes": 8053063680,
      "remaining_formatted": "7.5 GB",
      "percentage": 25
    },
    "generated_at": "2023-10-28T10:00:00Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

API key authentication. Include your VidNavigator API key in the X-API-Key header.

Response

Usage statistics retrieved successfully

​
status
enum<string>
Available options:
success
​
data
object