Usage Limits
beta

Get current usage

Get the values for each usage metric for the current day and month (UTC)

The reported usage is only guaranteed to reflect the full window when seedStatus is complete. A pending or partial status means the backfill is still in progress and the returned usage may understate actual usage, so retry later for an accurate total.

get/get_current_usage

Request

  • Base URL: https://happy-animal-123.convex.cloud/api/v1
  • URL: https://happy-animal-123.convex.cloud/api/v1/get_current_usage
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization
    • API key in header Authorization
    • API key in header Authorization

Response

metricsobject required
seedStatus'pending' | 'partial' | 'complete' | 'failed' required

Progress of the historical-usage backfill. Only complete guarantees the reported usage reflects the full window. While the status is pending or partial, history from before this deployment was loaded may not be hydrated yet and the numbers can understate actual usage, so retry later for an accurate total. failed means the backfill couldn't hydrate any history.

Changes

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