Account

Account Usage

Aggregated API usage for the calling key over the last N days (default 30): totals by day, by endpoint, and by client surface (excel / sdk-python / api). Surfaces are attributed via the optional X-Falpha-Surface request header. Available to any valid API key. Counts successful and failed requests (failures are recorded by the metering middleware with their status_code).

get/account/usage

Request

  • Base URL: https://api.falpha.ai
  • URL: https://api.falpha.ai/account/usage
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-API-Key

Query parameters

daysinteger

Aggregation window in days (max 90)

Response

Successful Response

window_daysinteger required

Size of the aggregation window in days

sincestring date-time required

UTC start of the aggregation window

totalinteger required

Total successful requests recorded in the window

meterobject

Unified work meter summed over the window: db_calls, db_docs, db_ms (see dbmeter contract). Requests are traffic; the meter is work.

Changes

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