---
title: "Get current user's usage overview"
method: GET
path: "/usage/me/overview"
tags: ["Usage"]
---

# Get current user's usage overview

`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`

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.

## Query parameters

- `range` 'period' | 'day' | 'week' | 'month' | 'custom'
- `from` string
- `to` string

## Headers

- `Authorization` string
- `x-api-key` string

## Response `200`

Usage overview

- UsageUsageOverviewResponseDoc
  - `code` integer
  - `data` UsageUsageOverviewDoc
    - `billing` UsageUsageBillingStateDoc
      - `allow_overage` boolean
      - `created_at` string
      - `credits_remaining` integer
      - `credits_used` integer
      - `currency` string
      - `daily_credit_limit` integer
      - `daily_credits_remaining` integer
      - `daily_credits_used` integer
      - `daily_key` string
      - `expected_subscription_amount_cents` integer
      - `expected_total_amount_cents` integer
      - `hard_limit` boolean
      - `included_credits` integer
      - `overage_credits` integer
      - `period_end` string
      - `period_key` string
      - `period_start` string
      - `plan` string
      - `pricing_source` string
      - `subscription_price_cents` integer
      - `updated_at` string
      - `user_id` string
    - `from` string
    - `range` string
    - `requests` UsageUsageRequestSummaryDoc
      - `avg_latency_ms` number
      - `distinct_ip_count` integer
      - `error_requests` integer
      - `last_request_at` string
      - `requests` integer
      - `success_requests` integer
    - `to` string
    - `usage` UsageUsageWindowSummaryDoc
      - `charged_requests` integer
      - `credits` integer
      - `failed_requests` integer
      - `non_billable_requests` integer
      - `overage` integer
      - `requests` integer
  - `msg` string

## Other responses

- `400`: Invalid query parameters
- `401`: Authentication required
- `500`: Internal server error

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)