Skip to main content
GET
Get the estimated cost of the sessions of a period summed over products

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

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.

name
string

Keep the products whose name contains this (case-insensitive)

tags
string[]

Keep the products that carry any of these tags

productIds
string[]

Keep only these products. A product outside the caller's grant is refused with 403; a product of another organization, or a deleted one, matches nothing. At most 25.

Maximum array length: 25

Response

The cost of the products

productCount
integer
required

The products whose sessions the cost adds up

costPerSession
number | null
required

Average estimated cost of the sessions of the period that carry one, from the list price of the model of each version. Null when no session carries a cost.

totalCost
number | null
required

Estimated cost of the sessions of the period. Null when no session carries a cost.

sessionsWithCostCount
integer
required

Sessions of the period that carry a cost

sessionsWithoutCostCount
integer
required

Sessions of the period that carry no cost, left out of costPerSession