Skip to main content
GET
Get the session outcomes of a product per day, week or month

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

from
string<date-time>
required

Start of the period, inclusive (ISO 8601)

to
string<date-time>
required

End of the period, exclusive (ISO 8601). A period that does not end after from, or is longer than 1830 days (5 years), is rejected with 400.

isProduction
boolean
required

Count production sessions when true, development sessions when false.

organizationId
string

The organization whose products to read. Defaults to the caller's own organization. Another organization reads products only for a caller that may read across organizations.

interval
enum<string>
required

The bucket size: a UTC calendar day, an ISO week (from Monday) or a calendar month

Available options:
day,
week,
month
Example:

"week"

Response

The session outcomes of the product per bucket

interval
enum<string>
required

The bucket size: a UTC calendar day, an ISO week (from Monday) or a calendar month

Available options:
day,
week,
month
Example:

"week"

series
object[]
required

One series that sums every version. Empty when the product is not readable.