Skip to main content
GET
Get costs for financial commitment report

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

financial_commitment_report_token
string
required

Query Parameters

start_date
string<date>

First date you would like to filter costs from, inclusive. YYYY-MM-DD formatted.

end_date
string<date>

Last date you would like to filter costs to, inclusive. YYYY-MM-DD formatted.

date_bin
enum<string>

The date bin of the costs. Defaults to the report's configured date bucket. Hourly costs are limited to 14 days.

Available options:
hour,
day,
week,
month,
quarter
groupings
string[]

Group the results by up to 100 fields. Valid groupings: cost_type, commitment_type, commitment_id, service, resource_account_id, provider_account_id, region, cost_category, cost_sub_category, instance_type, tag:<label_name>. Serialize as a CSV query parameter: groupings=cost_type,service. Repeated parameters (groupings[]=cost_type&groupings[]=service) are also accepted.

filter
string

The VQL filter to apply to the costs. Overrides the report's saved filter.

on_demand_costs_scope
enum<string>

The scope for the costs. Possible values: discountable, all.

Available options:
discountable,
all
order
enum<string>
default:desc

Whether to order costs by date in an ascending or descending manner.

Available options:
asc,
desc
limit
integer<int32>
default:2500

The number of cost rows to return, not the number of date buckets. The maximum is 5000.

Required range: 1 <= x <= 5000
page
integer<int32>
default:1

The page of results to return.

Response

FinancialCommitmentReportCosts model

total_amount
object
required
total_gross_amount
object
required
costs
object[]
required