Usage

Get current user's usage timeseries

Returns the signed-in user's request usage as UTC time buckets for charts. range is period (default), day, week, month or custom (with RFC3339 from and to); bucket is hour or day; endpoint filters to one endpoint such as google/search. Each bucket has start, end, requests, charged_requests, credits and overage. Empty buckets are filled with zeros.

get/usage/me/timeseries

Request

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

bucket'hour' | 'day'

Bucket size. Defaults to hour for day range and day otherwise.

endpointstring

Optional endpoint filter

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 timeseries

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "bucket": "day",
    "from": "2026-04-01T00:00:00Z",
    "items": [
      {
        "bucket_end": "2026-04-22T11:00:00Z",
        "bucket_start": "2026-04-22T10:00:00Z",
        "charged_requests": 28,
        "credits": 84,
        "failed_requests": 2,
        "non_billable_requests": 2,
        "requests": 32
      }
    ],
    "range": "period",
    "to": "2026-05-01T00:00:00Z"
  },
  "msg": "OK"
}

Changes

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