Skip to content
StackTaktDocs

Cost Report Endpoint

GET
/cost/report

The tenant’s cloud spend, derived from the latest completed sync per AWS account. Reads stored rows, never calls Cost Explorer.

Every figure is scoped to the accounts the caller can see (ADR-0023), and aws_account_id narrows to one of them, an out-of-scope value is the unrevealing 404, not an empty report.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
tenant_id
required
Tenant Id
string format: uuid
aws_account_id
Any of:
string format: uuid
Section titled “Cookie Parameters ”
st_session
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

CostReportResponse
object
active_job
Any of:
object
key
additional properties
any
anomalies
required
Anomalies
Array<object>
AnomalyRecord
object
account_name
required
Account Name
string
aws_account_id
required
Aws Account Id
string
dimension_value
required
Any of:
string
ended_at
required
Any of:
string format: date-time
external_id
required
External Id
string
id
required
Id
string format: uuid
impact_percentage
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
max_impact
required
Max Impact
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
root_causes
required
Root Causes
Array<object>
object
key
additional properties
any
started_at
required
Started At
string format: date-time
total_expected
required
Total Expected
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_impact
required
Total Impact
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
asset_count
required
Asset Count
integer
attribution
required
Attribution
object
buckets
required
Buckets
Array<object>
AttributionBucket
object
amount
required
Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
bucket
required
Bucket
string
share_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
resource_level
required
Resource Level
string
top_unattributed_services
required
Top Unattributed Services
Array<object>
UnattributedService
object
amount
required
Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
service
required
Service
string
window_end
required
Window End
string format: date
window_start
required
Any of:
string format: date
window_total
required
Window Total
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
budget
required
Any of:
BudgetPace
object
alert_threshold_percent
required
Alert Threshold Percent
integer
currency
required
Currency
string
monthly_amount
required
Monthly Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
pace_percent
required
Pace Percent
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
projected_percent
required
Projected Percent
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
remaining
required
Remaining
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
spent
required
Spent
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
status
required
Status
string
updated_at
required
Updated At
string format: date-time
updated_by
required
Updated By
string
used_percent
required
Used Percent
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
by_account
required
By Account
Array<object>
AccountSpend
object
aws_account_id
required
Aws Account Id
string
data_classification
required
Any of:
string
delta_amount
required
Delta Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
delta_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
environment
required
Any of:
string
last_error
required
Any of:
string
month_to_date
required
Month To Date
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
name
required
Name
string
prior_period
required
Prior Period
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
resource_level
required
Resource Level
string
share_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
stale
required
Stale
boolean
synced_at
required
Any of:
string format: date-time
tenant_aws_account_id
required
Tenant Aws Account Id
string format: uuid
by_asset
required
By Asset
Array<object>
AssetSpend
object
amount
required
Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
attribution
required
Attribution
string
aws_account_id
required
Aws Account Id
string
daily_average
required
Daily Average
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
data_classification
required
Any of:
string
managed_resource_id
required
Any of:
string format: uuid
name
required
Name
string
origin
required
Any of:
string
resource_id
required
Resource Id
string
resource_type
required
Resource Type
string
service
required
Service
string
by_region
required
By Region
Array<object>
RegionSpend
object
month_to_date
required
Month To Date
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
region
required
Region
string
share_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
by_service
required
By Service
Array<object>
ServiceSpend
object
delta_amount
required
Delta Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
delta_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
month_to_date
required
Month To Date
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
prior_period
required
Prior Period
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
service
required
Service
string
share_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
daily_trend
required
Daily Trend
Array<object>
TrendPoint
object
amount
required
Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
date
required
Date
string format: date
degradations
required
Degradations
Array<object>
Degradation

A capability the sync could not read, with the fix. Rendered where the missing panel would be, never swallowed.

object
account_name
required
Account Name
string
aws_account_id
required
Aws Account Id
string
capability
required
Capability
string
detail
required
Detail
string
month_comparison
required
Month Comparison
Array<object>
ComparisonPoint
object
current
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
day
required
Day
integer
prior
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
mover_window_days
required
Mover Window Days
integer
movers
required
Movers
object
decreases
required
Decreases
Array<object>
Mover
object
delta_amount
required
Delta Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
delta_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
previous
required
Previous
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
recent
required
Recent
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
service
required
Service
string
increases
required
Increases
Array<object>
Mover
object
delta_amount
required
Delta Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
delta_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
previous
required
Previous
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
recent
required
Recent
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
service
required
Service
string
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
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
totals
required
ReportTotals
object
change_amount
required
Change Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
change_percent
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
complete_days
required
Complete Days
integer
daily_run_rate
required
Daily Run Rate
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
days_in_month
required
Days In Month
integer
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*$/
projection_lower
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
projection_source
required
Projection Source
string
projection_upper
required
Any of:
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