COconductorone
Spend Insights

Get Overview

Changed on

Get an organization-wide spend overview for a requested time window. Returns current budget headroom, trends, forecasts, usage coverage, and denials.

post/api/v1/spend-insights/overview

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/spend-insights/overview
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

endTimestring date-time nullable
startTimestring date-time nullable

Response

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

accountInitializedboolean

Whether the current organization budget account has recorded activity.

availability'REPORTING_AVAILABILITY_UNSPECIFIED' | 'REPORTING_AVAILABILITY_COMPLETE' | 'REPORTING_AVAILABILITY_PARTIAL_RETENTION' | 'REPORTING_AVAILABILITY_OUTSIDE_RETENTION' | 'REPORTING_AVAILABILITY_NO_ACTIVITY'

Data availability for the requested reporting window.

availableEndstring date-time nullable
availableStartstring date-time nullable
committedNanostring int64

Settled plus reserved spend in the current budget period.

consumedNanostring int64

Spend settled in the current budget period.

currencyCodestring

Currency used for monetary values.

denialEventsstring int64

Number of budget refusals in the reporting window.

distinctAppCountinteger

Number of distinct applications with settled calls.

hasPriorWindowboolean

Whether a complete preceding equal-length window is available.

hasRemainingNanoboolean

Whether remaining_nano is available for this budget.

limitNanostring int64

Current organization spend limit.

periodEndstring date-time nullable
periodStartstring date-time nullable
priorWindowConsumedNanostring int64

Exact settled spend in the preceding equal-length window.

remainingNanostring int64

Current spend headroom after settled and reserved spend.

reportingEndstring date-time nullable
reportingStartstring date-time nullable
reportingWindowConsumedNanostring int64

Exact settled spend in the requested reporting window.

reservedNanostring int64

Spend reserved by in-progress calls.

state'OVERVIEW_STATE_UNSPECIFIED' | 'OVERVIEW_STATE_RESOLVED' | 'OVERVIEW_STATE_NO_POLICY' | 'OVERVIEW_STATE_NO_CEILING'

Whether spend governance is configured for the organization.

Changes

  • fe943bedf41bRevision changes
    • breaking

      added to the // response property oneOf list for the response status

    • info

      removed from the // response property oneOf list for the response status

  • 918a4e749f56Revision changes
    • info

      endpoint added