Skip to main content
GET
Get analytics data

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[]

Filter by version IDs

testIds
string[]

Filter by test IDs

metricIds
string[]

Filter by metric IDs

from
string

Start date for filtering (epoch milliseconds). Ranges wider than 1830 days (5 years) are rejected with 400.

to
string

End date for filtering (epoch milliseconds)

languages
string[]

Filter by language codes

isProduction
boolean

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

Response

Analytics data retrieved successfully

Analytics data containing evaluation results and metrics. Each entry in averages.total carries a per-version coverage number (0-100, same scale as score): the percentage of the product's non-deleted test cases that have at least one completed evaluation under that version. It is 0 when the product has no test cases or the version evaluated none, and is computed independently of the isProduction filter.

groups
object[]