Usage

Get current user's endpoint usage breakdown

Returns the signed-in user's usage broken down by endpoint, ordered by request volume. range is period (the current billing period, default), day, week, month or custom, which takes RFC3339 from and to. limit defaults to 20 (max 100). Each item has requests, charged_requests, failed_requests, non_billable_requests, credits and overage. Authenticated with a dashboard JWT.

get/usage/me/endpoints

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/usage/me/endpoints
  • 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.

limitinteger

Maximum endpoints to return. Defaults to 20 and clamps to 100.

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

Endpoint usage breakdown

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "from": "2026-04-01T00:00:00Z",
    "items": [
      {
        "charged_requests": 220,
        "credits": 660,
        "endpoint": "google/search",
        "failed_requests": 8,
        "non_billable_requests": 12,
        "requests": 240
      }
    ],
    "range": "period",
    "to": "2026-05-01T00:00:00Z"
  },
  "msg": "OK"
}

Changes

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