Skip to main content
GET
Get a cost forecast

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cost_forecast_id
string<uuid>
required

Unique identifier for a cost forecast.

Response

200 - application/json

OK

cost
object
required

An estimate of the "cost" of servicing a set of subscription constraints.

Cost has two components:

  • The number of rows which must be read in order to find data which matches the subscription constraints.
  • An estimate of the "size" of those rows in bytes.

Note: the number of rows reported in the cost is not an estimate of the number of rows which will be purchased as part of a subscription using the given constraints.

company_id
integer
required

Unique identifier for the company to which the cost forecast belongs.

created_at
string
required

ISO-8601 timestamp indicating when the cost forecast was created

details
object
required

The set of constraints to which the cost forecast applies.

id
string<UUID>

Unique identifier for the cost forecast. Empty if no cost forecast was created due to the subscriptions constraints resulting in no matches.

subscription_id
string<UUID>

Unique identifier of the subscription for which the cost forecast was created. Empty if the cost forecast is not associated with a subscription.