Usage

Get this month's usage

This calendar month's (UTC) recordings: the analytics.recording meter of the organisation's billing account (its free allowance, what is used, held and charged), whether a new recording would be admitted now and, if not, whether Ironfang paused it, the organisation holds its stored-bytes limit or billing refuses it, and the organisation's capacity: sites, open recordings, and what it stores against what it may. A recording belongs to the month it was admitted in. Needs analytics.usage.read.

get/v1/usage

Request

  • Base URL: https://api.ironfang.com/analytics
  • URL: https://api.ironfang.com/analytics/v1/usage
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Response

This month's usage

max_open_recordingsinteger nullable required

Recordings the organisation may have open at once; null for no limit of its own.

max_sitesinteger required

Sites the organisation may have.

max_stored_bytesinteger required

What the organisation's unexpired recordings may hold: once stored_bytes reaches it, no new recording is admitted (the collector answers 429 storage_limit) until expiry or deletion frees room. 10 GiB, unless a managed partner's agreement sets another figure; paying more does not lift it.

open_recordingsinteger required

Recordings admitted and not yet ended.

period_endstring date-time required
period_startstring date-time required

The first instant of the UTC calendar month the figures are for.

recordingsinteger required

Recordings admitted in the month and kept: the billing count when billing is on.

stored_bytesinteger required

What the organisation's unexpired recordings hold.

Changes

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