Skip to main content
GET
Get metrics for a specific experiment run. Metrics are consensus likelihoods on the [0.0, 1.0] scale where 0.0 is low agreement and 1.0 is total agreement. The view query parameter selects one of four successful response shapes. In responses, branch on kind; it is the shared discriminator for the response shape. Because this endpoint is scoped to a concrete run_id, it returns historical metrics for that run even if the experiment definition has since changed. Use the experiment’s freshness / run_plan_mode fields from experiments.get or experiments.list to decide whether to create a newer run. Pass include_prior=false to omit prior-run comparison fields, or prior_run_id=... to override which run is treated as the prior.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

run_id
string
required
view
enum<string>
default:summary
Available options:
summary,
by_document,
by_target,
votes
document_id
string | null
target_path
string | null
include_prior
boolean
default:true
prior_run_id
string | null

Response

Successful Response

Run-level summary plus block-specific diagnostics.

prior_run_id + prior_score populate when the request opts into prior-comparison and a completed prior run exists.

score and documents cover only the documents that produced a result. Compare scored_document_count against total_document_count to see whether any of the run's documents failed and were left out.

experiment_id
string
required
run_id
string
required
block_type
enum<string>
required
Available options:
extract,
classifier,
split,
for_each
kind
string
default:summary
Allowed value: "summary"
view
string
default:summary
Allowed value: "summary"
block_execution_fingerprint
string | null
score
number | null
prior_score
number | null
documents
ExperimentSummaryMetricDocument · object[]
scored_document_count
integer
total_document_count
integer
aggregate
ExperimentExtractSummaryAggregate · object

Extract-only diagnostics attached to the summary response.

prior_run_id
string | null