Skip to content
StackTaktDocs

Org Cost Report

GET
/cost/org-report

Cloud spend across every tenant the caller reaches, summed here.

Organization scope is the union of the caller’s reachable tenants, and each tenant’s figures are filtered to the AWS accounts they can see there (ADR-0023), the same filter GET /cost/report applies, tenant by tenant. No AWS call: this reads the stored rows the syncs wrote.

The addition happens server-side in Decimal, like every other total in this API. A browser summing decimal strings would be summing floats, and the organization figure would disagree with the tenant figures it is made of.

Parameters

Section titled “ Parameters ”
Section titled “Cookie Parameters ”
st_session
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

OrgCostReportResponse
object
by_service
required
By Service
Array<object>
OrgServiceSpend
object
month_to_date
required
Month To Date
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
service
required
Service
string
currency
required
Any of:
string
mixed_currency
required
Mixed Currency
boolean
period
required
ReportPeriod
object
complete_days
required
Complete Days
integer
days_in_month
required
Days In Month
integer
month_start
required
Month Start
string format: date
prior_month_start
required
Prior Month Start
string format: date
prior_period_end
required
Prior Period End
string format: date
today
required
Today
string format: date
synced_at
required
Any of:
string format: date-time
tenant_count
required
Tenant Count
integer
tenants
required
Tenants
Array<object>
OrgTenantSpend

One tenant’s line in the organization roll-up, in its own currency.

object
account_count
required
Account Count
integer
budget_status
required
Any of:
string
budget_used_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
change_amount
required
Change Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
change_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
degradation_count
required
Degradation Count
integer
month_to_date
required
Month To Date
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
prior_month_same_period
required
Prior Month Same Period
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
projected_month_end
required
Projected Month End
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
projection_source
required
Projection Source
string
readiness
required
Readiness

Why the report is empty, when it is. detail is rendered verbatim.

object
detail
required
Detail
string
state
required
State
string
synced_at
required
Any of:
string format: date-time
tenant_id
required
Tenant Id
string format: uuid
tenant_name
required
Tenant Name
string
totals
required
Any of:
OrgTotals
object
change_amount
required
Change Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
change_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
month_to_date
required
Month To Date
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
prior_month_full
required
Prior Month Full
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
prior_month_same_period
required
Prior Month Same Period
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
projected_month_end
required
Projected Month End
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string