Usage

Get current user's usage overview

Returns a JWT-authenticated user's current billing snapshot plus recent request and credit consumption metrics for the selected UTC time range. The requests summary is limited to product API traffic and excludes console, billing, usage, and user-management endpoints.

get/usage/me/overview

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/usage/me/overview
  • Auth: API key in header x-api-key

Query parameters

range'period' | 'day' | 'week' | 'month' | 'custom'

Time range preset. Defaults to the current billing period.

fromstring

Custom lower bound in RFC3339 format when range=custom

tostring

Custom upper bound in RFC3339 format when range=custom

Headers

Authorizationstring

Dashboard JWT in the form Token <jwt> (use this or x-api-key)

x-api-keystring

API key (alternative to a dashboard JWT)

Response

Usage overview

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "billing": {
      "allow_overage": true,
      "created_at": "2026-04-01T00:00:00Z",
      "credits_remaining": 398750,
      "credits_used": 1250,
      "currency": "usd",
      "daily_credit_limit": 25000,
      "daily_credits_remaining": 24100,
      "daily_credits_used": 900,
      "daily_key": "2026-04-22",
      "expected_subscription_amount_cents": 7900,
      "expected_total_amount_cents": 7900,
      "included_credits": 400000,
      "period_end": "2026-05-01T00:00:00Z",
      "period_key": "2026-04",
      "period_start": "2026-04-01T00:00:00Z",
      "plan": "Pro",
      "pricing_source": "plan_default",
      "subscription_price_cents": 7900,
      "updated_at": "2026-04-22T12:00:00Z",
      "user_id": "user-1"
    },
    "from": "2026-04-01T00:00:00Z",
    "range": "period",
    "requests": {
      "avg_latency_ms": 824.5,
      "distinct_ip_count": 3,
      "error_requests": 30,
      "last_request_at": "2026-04-22T12:00:00Z",
      "requests": 420,
      "success_requests": 390
    },
    "to": "2026-05-01T00:00:00Z",
    "usage": {
      "charged_requests": 380,
      "credits": 1140,
      "failed_requests": 15,
      "non_billable_requests": 25,
      "requests": 420
    }
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.