Skip to main content
GET
Get the calibration report for the active version

Authorizations

Authorization
string
header
required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Path Parameters

ns
string
required

A namespace name, or a template prefix ending in /*, with any / sent as %2F: acme%2Fprod%2Ftenant_123 or acme%2Fprod%2F*.

A namespace name, or a template prefix: a namespace path ending in /*, such as acme/prod/*, which every namespace under acme/prod/ inherits judgments from. Up to 256 bytes. Never exactly . or .., which a URL path can't carry.

Required string length: 1 - 256
Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+(/\*)?$
name
string
required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The report.

How well the active version's answers match their outcomes. epochs holds one entry per engine epoch with outcomes, newest first. An epoch is the engine_version its evaluations were computed under: each Jev epoch label, or the exact version for a pinned engine.

judgment
string
required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
type
enum<string>
required
Available options:
bool,
choice,
score
version
integer<int32>
required

The active version the report is for.

Required range: x >= 1
outcomes
integer<int64>
required

Outcomes joined to evaluations of this version, across every epoch, implicit negatives included.

Required range: x >= 0
outcomes_by_source
object
required

Joined outcomes by where they came from, summing to outcomes.

rule_outcomes_paused
integer<int64>
required

Rule outcomes left out because the organization's plan did not include outcome rules when they were observed. They are kept, and count again only for outcomes observed while the plan includes rules. 0 on Team and Scale throughout.

Required range: x >= 0
unmatched_outcomes
object
required

Outcomes, posted or derived by rules, that add no sample to the report's version, by reason. They are kept, and count if a later evaluation or window takes them.

censored_predictions
object
required

Prediction windows with no outcome that are not counted as implicit negatives. All are 0 unless outcomes.implicit_negatives is on.

epochs
object[]
required
lift
object | null
required

How much calibration has cut this version's error since the learning loop started, on held-out outcomes. On every plan; the dashboard shows its history on Team and above, and its headline as a preview on Developer. Null for a composite, whose p is its combiner's, and on a template's tenant: the template's report has the pool's lift.

selection
object

For an options.from judgment, how often the pick equals the outcome where a match existed. Reported, never fitted.

match_misses
object

For an options.from judgment, outcomes naming a document its evaluation did not read, by cause: created after the evaluation's watermark, cut by last_n (the number that says whether the oldest candidates matter), not in the block (a bad key), or the evaluation failed.