FurniOpsDocs
API referenceUsage

Read one meter over time

One meter by hour (up to 7 days) or by day (up to 400 days), in the caller's mode; periods without usage are left out. A level meter's point is its highest reading in the period.

  • Scopesusage:read
  • Rate classread
GET/v1/usage/series

One meter by hour (up to 7 days) or by day (up to 400 days), in the caller's mode; periods without usage are left out. A level meter's point is its highest reading in the period.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Query Parameters

meter*string

Value in

  • "api_calls"
  • "webhooks_delivered"
  • "export_rows"
  • "products_tracked"
  • "source_runs"
  • "ai_tokens"
  • "mcp_calls"
granularity?string
Default"day"

Value in

  • "hour"
  • "day"
from*string

Start, inclusive (rounded down to the period)

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
to*string

End, exclusive

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
If-None-Match?string

ETag of a cached representation; a match returns 304

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/usage/series?meter=api_calls&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"
{  "object": "usage_series",  "meter": "api_calls",  "granularity": "hour",  "livemode": true,  "data": [    {      "start": "2019-08-24T14:15:22Z",      "quantity": 0    }  ]}

List the user's organisations GET

Every organisation the signed-in user belongs to, with their role in it, by name; one page (at most 100). A user's token only: an API key, a machine client or a support session answers 403 `permission_denied`. Switching organisation means a new token for it.

Read the month's usage GET

Every meter's usage in a calendar month (UTC), in the caller's mode, against its quota. Counts add up over the month; a level (products tracked) is its highest reading. Quotas cap live mode only: at 80% the organisation receives `usage.threshold_reached`, and at 100% the metered action answers 429 `quota_exceeded` until the month ends. API calls are counted as they happen and may lag by a few seconds.