Usage

This month's metered use, capacity and hosted evidence

The month (UTC) as the organisation's billing account has it for Ironfang Audit's meters - captures (audit.capture) and retention_extension (audit.retention_extension): the free allowance, what has been settled, what admitted audits still hold, and the charge so far before tax. Both are null where unified billing is not running (billing_enabled false): audits are then admitted on capacity alone and nothing is metered. Beside them, the facts that are not billing: sites against site_limit and max_pages_per_audit (capacity limits, the same for everyone), the standard hosted retention new audits get, hosted bytes and the next expiry, the projection of captures the active scheduled monitors may ask for this month (pages x runs, an upper bound), and daily captures by UTC day of admission. quota is deprecated: the launch-era shape, now captures against the month's free allowance only.

get/v1/usage

Request

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

Response

Usage

auditsinteger required
billing_enabledboolean required

False where unified billing is not running; nothing is metered then.

billing_modestring

The billing account's mode: free, setup_pending, enabled, paused or closed.

catalogue_versionstring

The rate catalogue version pricing the month.

credits_consumedinteger

Page captures every audit of the organisation has been charged (and launch-era credits).

earliest_expirystring date-time
max_pages_per_auditinteger required

The per-audit page cap; each site's own page limit applies within it.

period_endstring date-time required
period_startstring date-time required
quotaobject required

The launch-era quota shape, kept for existing readers - captures against the month's free allowance only. Use captures.

retained_bytesinteger required
site_limitinteger required

The site capacity limit; the same for every organisation.

sitesinteger required
standard_retention_daysinteger required

The hosted retention a new audit is promised.

Changes

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