How it is versioned
- The API version goes in the path: today it is
v1, andGET /healthreports it inapi_version. - Additive changes do not change the version: a new field in a response, an optional parameter or a new endpoint. Your client should ignore fields it does not know.
- A contract change (removing or renaming a field, or changing what it means) is announced here with its date and what to do.
- The methodology (the rules behind every claim) has its own version:
GET /v1/methodologyreturnsversionandfingerprint. Thefingerprintchanges when any threshold changes, even if the code does not.
Sealed evidence packages record the methodology version they were built with, so an old report can be reproduced and
verified with the rules of its time.
Recent changes
New
GET /v1/audit, GET /v1/audit/{id} and GET /v1/audit/{id}/{section}, free of charge. An audit is visible only
to its organization. While the audit engine is not available, they return synthetic audits marked demo: true.On the
enterprise plan, everything the organization spends counts against its quota and stops when it runs out,
including organization keys and keys of members on another plan. X-Credits-* and GET /v1/account show the account
with the lowest balance, and credits.shared says whether it is the organization’s.viewerrole and organization keys withscopesandread_only. Anything not allowed returns403witherror: "read_only"orerror: "key_scope".- Contract change:
enterpriseis no longer unlimited. Its monthly quota is the organization’s (5,000,000 credits by default) andX-Credits-Limitis always a number. - A cap on reads from the data sources per query (4,000 by default). Past the cap,
reason: "budget_exhausted".