Skip to main content
POST
GetOverview

Authorizations

Authorization
string
header
required

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

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

GetOverviewRequest specifies a reporting window of at most 90 days.

endTime
string<date-time> | null
startTime
string<date-time> | null

Response

200 - application/json

GetOverviewResponse contains current budget state and spend activity for the requested reporting window.

GetOverviewResponse contains current budget state and spend activity for the requested reporting window.

accountInitialized
boolean

Whether the current organization budget account has recorded activity.

availability
enum<string>

Data availability for the requested reporting window.

Available options:
REPORTING_AVAILABILITY_UNSPECIFIED,
REPORTING_AVAILABILITY_COMPLETE,
REPORTING_AVAILABILITY_PARTIAL_RETENTION,
REPORTING_AVAILABILITY_OUTSIDE_RETENTION,
REPORTING_AVAILABILITY_NO_ACTIVITY
availableEnd
string<date-time> | null
availableStart
string<date-time> | null
committedNano
string<int64>

Settled plus reserved spend in the current budget period.

consumedNano
string<int64>

Spend settled in the current budget period.

coverage
Attribution Coverage · object | null

AttributionCoverage explains gaps between settled spend and retained call-level usage.

currencyCode
string

Currency used for monetary values.

denialEvents
string<int64>

Number of budget refusals in the reporting window.

distinctAppCount
integer<int32>

Number of distinct applications with settled calls.

forecast
Run Rate Forecast · object | null

RunRateForecast describes expected spend through the end of the current budget period. Complete-day averages include zero-spend days.

hasPriorWindow
boolean

Whether a complete preceding equal-length window is available.

hasRemainingNano
boolean

Whether remaining_nano is available for this budget.

limitNano
string<int64>

Current organization spend limit.

periodEnd
string<date-time> | null
periodStart
string<date-time> | null
priorWindowConsumedNano
string<int64>

Exact settled spend in the preceding equal-length window.

rateBasis
Rate Basis Count · object[] | null

Recorded price bases used by settled calls.

remainingNano
string<int64>

Current spend headroom after settled and reserved spend.

reportingEnd
string<date-time> | null
reportingStart
string<date-time> | null
reportingWindowConsumedNano
string<int64>

Exact settled spend in the requested reporting window.

reservedNano
string<int64>

Spend reserved by in-progress calls.

state
enum<string>

Whether spend governance is configured for the organization.

Available options:
OVERVIEW_STATE_UNSPECIFIED,
OVERVIEW_STATE_RESOLVED,
OVERVIEW_STATE_NO_POLICY,
OVERVIEW_STATE_NO_CEILING
tokens
Token Economics · object | null

TokenEconomics summarizes token usage and cost for settled calls.

trajectory
Trajectory Point · object[] | null

Daily settled-spend totals for the reporting window.