Evaluations
Show a release comparison and its verdict
GET /v1/release-comparisons/{releaseComparisonId} · SDK getReleaseComparison · CLI deployments eval comparison show
GET
Requires observability:read.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
releaseComparisonId*stringRelease comparison ID.
Match
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-project*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$ReleaseComparisonResponse
application/json- response
baseline*candidate*completedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecreatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timedatasetId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$error?gateMode*"advisory"Value in
"advisory"gatePolicy*id*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$reasons*array<string>report?runtimeConfigFromAgentDeploymentId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$scoreDefinitions*array<>status*stringValue in
"completed""failed""queued""running"summary?updatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeverdict?stringValue in
"error""fail""pass"version*integerRange
0 <= value <= 9007199254740991curl -X GET "https://example.com/v1/release-comparisons/string" \ -H "x-deployments-organization: string" \ -H "x-deployments-project: string" \ -H "x-deployments-environment: string"{ "baseline": { "agentReleaseId": "string", "evaluationRunId": "string", "releaseContentHash": "string" }, "candidate": { "agentReleaseId": "string", "evaluationRunId": "string", "releaseContentHash": "string" }, "completedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "datasetId": "string", "error": { "code": "string", "message": "string" }, "gateMode": "advisory", "gatePolicy": { "maxEvaluatorErrorRate": 0, "maxMeanDecrease": 0, "maxMissingEvidenceRate": 0, "maxNewFailures": 0, "maxPassRateDecrease": 0, "minComparableCases": 1 }, "id": "string", "reasons": [ "string" ], "report": { "json": { "contentType": "string", "downloadUrl": "string", "downloadUrlExpiresAt": "2019-08-24T14:15:22Z", "sha256": "string", "sizeBytes": 0 }, "markdown": { "contentType": "string", "downloadUrl": "string", "downloadUrlExpiresAt": "2019-08-24T14:15:22Z", "sha256": "string", "sizeBytes": 0 } }, "runtimeConfigFromAgentDeploymentId": "string", "scoreDefinitions": [ { "evaluatorVersionHash": "string", "name": "string", "revision": 1, "scoreDefinitionId": "string", "threshold": 0, "type": "deterministic" } ], "status": "completed", "summary": { "comparableCases": 0, "costUsdMicros": { "baselineTotal": 0, "candidateTotal": 0, "delta": 0 }, "definitions": [ { "baselineMean": 0, "baselinePassRate": 0, "candidateMean": 0, "candidatePassRate": 0, "meanDelta": 0, "name": "string", "passRateDelta": 0, "revision": 0, "scoreDefinitionId": "string" } ], "evaluatorErrors": { "baseline": 0, "candidate": 0 }, "latency": { "baselineP50Ms": 0, "baselineP95Ms": 0, "candidateP50Ms": 0, "candidateP95Ms": 0, "p50DeltaMs": 0, "p95DeltaMs": 0 }, "missingEvidence": { "baseline": 0, "candidate": 0 }, "regressions": 0, "tokens": { "baselineTotal": 0, "candidateTotal": 0, "delta": 0 }, "totalCases": 0 }, "updatedAt": "2019-08-24T14:15:22Z", "verdict": "error", "version": 0}