Skip to main content
GET
Get cross-version analytics comparison insights

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Query Parameters

productId
string
required

Product ID (required)

versionIds
string[]

Version IDs to compare. When omitted, all versions present in the analytics data are compared.

testIds
string[]

Filter by test IDs

metricIds
string[]

Filter by metric IDs

languages
string[]

Filter by language codes

from
string<date-time>

Start date for filtering

to
string<date-time>

End date for filtering

includeNarrative
boolean
default:true

When true (default), a fail-open LLM-generated narrative summary is computed and returned alongside the deterministic flags. When false, the narrative LLM call is skipped entirely and the response carries narrative: null and narrativeGeneratedByAi: false; the deterministic flags are unchanged. Machine consumers that produce their own prose should pass false to avoid the wasted LLM call.

isProduction
boolean

When set, returns only production (true) or only development (false) data. Omit to include both.

Response

Cross-version analytics comparison insights computed successfully

Cross-version analytics comparison insights: deterministic flags plus a fail-open LLM-generated narrative summary (the narrative is omitted when the request sets includeNarrative=false).

productId
string
required
Example:

"prod_123"

versionIds
string[]
required
Example:
status
enum<string>
required
Available options:
all_good,
flags_present
Example:

"flags_present"

flags
object[]
required
narrativeGeneratedByAi
boolean
required

True when the narrative was successfully produced by the LLM; false otherwise (including when includeNarrative=false).

narrative
string | null

LLM-generated narrative summary, or null when generation was skipped (includeNarrative=false or no flags) or failed.

Example:

"Faithfulness regressed from v2 to v3 while latency on v3 is 1.6× the cheapest version."