Get Overview
Get an organization-wide spend overview for a requested time window. Returns current budget headroom, trends, forecasts, usage coverage, and denials.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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
Response
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.
Whether the current organization budget account has recorded activity.
Data availability for the requested reporting window.
REPORTING_AVAILABILITY_UNSPECIFIED, REPORTING_AVAILABILITY_COMPLETE, REPORTING_AVAILABILITY_PARTIAL_RETENTION, REPORTING_AVAILABILITY_OUTSIDE_RETENTION, REPORTING_AVAILABILITY_NO_ACTIVITY Settled plus reserved spend in the current budget period.
Spend settled in the current budget period.
AttributionCoverage explains gaps between settled spend and retained call-level usage.
Currency used for monetary values.
Number of budget refusals in the reporting window.
Number of distinct applications with settled calls.
RunRateForecast describes expected spend through the end of the current budget period. Complete-day averages include zero-spend days.
Whether a complete preceding equal-length window is available.
Whether remaining_nano is available for this budget.
Current organization spend limit.
Exact settled spend in the preceding equal-length window.
Recorded price bases used by settled calls.
Current spend headroom after settled and reserved spend.
Exact settled spend in the requested reporting window.
Spend reserved by in-progress calls.
Whether spend governance is configured for the organization.
OVERVIEW_STATE_UNSPECIFIED, OVERVIEW_STATE_RESOLVED, OVERVIEW_STATE_NO_POLICY, OVERVIEW_STATE_NO_CEILING TokenEconomics summarizes token usage and cost for settled calls.
Daily settled-spend totals for the reporting window.