Documentation

Cost Reports

cost_reports

Methods

Get Monthly Cost Report Totals Commits And Pay As You Go -> { count, price_status, results }
post/v1/reservation_cost_report/totals

Retrieve a detailed cost report totals for a specified month, which includes both commit and pay-as-you-go (overcommit) prices. Additionally, it provides the spent billing units (e.g., hours or GB) for resources. The "time_to" parameter represents all days in the specified month.

Receiving data from the past hour might lead to incomplete statistics. For the most accurate data, we recommend accessing the statistics after at least one hour. Typically, updates are available within a 24-hour period, although the frequency can vary. Maintenance periods or other exceptions may cause delays, potentially extending beyond 24 hours until the servers are back online and the missing data is filled in.

Response fields
count: number
(minimum: 0)

Total count of the totals

price_status: "error" | "hide" | "show"

Price status for the UI, type: string

results: Array<{ billing_metric_name, billing_value, billing_value_unit, 9 more... } | { billing_metric_name, billing_value, billing_value_unit, 9 more... } | { billing_metric_name, billing_value, billing_value_unit, 9 more... } | 21 more...>
Request example
200Example
Get Cost Report Resources Pay As You Go Only -> OffsetPage<{ billing_metric_name, billing_value, billing_value_unit, 15 more... } | { billing_metric_name, billing_value, billing_value_unit, 15 more... } | { billing_metric_name, billing_value, billing_value_unit, 15 more... } | 21 more...>
post/v1/cost_report/resources

Get a detailed cost report for a given period and specific resources. Requested period should not exceed 31 days.

Note: This report assumes there are no active commit features in the billing plan. If there are active commit features (pre-paid resources) in your plan, use /v1/reservation_cost_report/totals, as the results from this report will not be accurate.

Receiving data from the past hour might lead to incomplete statistics. For the most accurate data, we recommend accessing the statistics after at least one hour. Typically, updates are available within a 24-hour period, although the frequency can vary. Maintenance periods or other exceptions may cause delays, potentially extending beyond 24 hours until the servers are back online and the missing data is filled in.

Get Cost Report Totals Pay As You Go Only -> { count, price_status, results }
post/v1/cost_report/totals

Get cost report totals (aggregated costs) for a given period. Requested period should not exceed 31 days.

Note: This report assumes there are no active commit features in the billing plan. If there are active commit features (pre-paid resources) in your plan, use /v1/reservation_cost_report/totals, as the results from this report will not be accurate.

Receiving data from the past hour might lead to incomplete statistics. For the most accurate data, we recommend accessing the statistics after at least one hour. Typically, updates are available within a 24-hour period, although the frequency can vary. Maintenance periods or other exceptions may cause delays, potentially extending beyond 24 hours until the servers are back online and the missing data is filled in.

Get Usage Statistics Report -> { count, resources, totals }
post/v1/usage_report

Receiving data from the past hour might lead to incomplete statistics. For the most accurate data, we recommend accessing the statistics after at least one hour. Typically, updates are available within a 24-hour period, although the frequency can vary. Maintenance periods or other exceptions may cause delays, potentially extending beyond 24 hours until the servers are back online and the missing data is filled in.

Cost Reports

Billing Reports

cost_reports.billing_reports

Methods

Deprecated Get Cost Report Pay As You Go Only -> { count, price_status, results, 1 more... }
Deprecated
post/v1/billing_report

Get a detailed cost report for a given period. Use /v1/cost_report/resources and /v1/cost_report/totals instead, because they provide more accurate results. Note: This report assumes there are no active commit features in the billing plan. If there are active commit features (pre-paid resources) in your plan, use the /v2/billing_report, as the results from this report will not be accurate. Receiving data from the past hour might lead to incomplete statistics. For the most accurate data, we recommend accessing the statistics after at least one hour. Typically, updates are available within a 24-hour period, although the frequency can vary. Maintenance periods or other exceptions may cause delays, potentially extending beyond 24 hours until the servers are back online and the missing data is filled in.

Deprecated Get Monthly Cost Report Commits And Pay As You Go -> { count, price_status, results, 1 more... }
Deprecated
post/v2/billing_report

Retrieve a detailed cost report for a specified month. Use /v1/reservation_cost_report/totals instead, which provides more accurate results. This report includes "totals" for both commit and pay-as-you-go (overcommit) prices. Additionally, it provides the spent billing units (e.g., hours or GB) for resources. The "time_to" parameter represents all days in the specified month. Receiving data from the past hour might lead to incomplete statistics. For the most accurate data, we recommend accessing the statistics after at least one hour. Typically, updates are available within a 24-hour period, although the frequency can vary. Maintenance periods or other exceptions may cause delays, potentially extending beyond 24 hours until the servers are back online and the missing data is filled in.