Skip to main content
GET
Get the test-case coverage per version for a product

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

The product to read

Minimum string length: 1
versionIds
string[]

Filter by version IDs

testIds
string[]

Filter by test IDs

metricIds
string[]

Filter by metric IDs

specificationIds
string[]

Narrow results to the metrics these specifications link; combines with metricIds as an intersection.

languages
string[]

Filter by language codes

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)

isProduction
boolean

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

Response

The coverage of the product

groups
object[]
required

Per test type, as the coverage fields of averages.groups on GET /analytics. sharedCoverage is absent for a group with no test-case coverage, such as PRODUCTION.

total
object[]
required

Over every test type, as the coverage fields of averages.total on GET /analytics

sharedCoverage
object
required

Over every test type, as averages.sharedCoverage on GET /analytics