Metrics (Beta)

Organization-level metrics and overview

Get organization overview

get

Returns a high-level overview of the organization's commitment performance including savings, coverage, utilization, missed savings opportunities, automation status, and prioritized recommended actions.

Path parameters
org_idstring · uuidRequired
Query parameters
providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:
Responses
chevron-right
200

OK

application/json
monthly_net_savingsnumberOptional

Current monthly net savings rate from active commitments

expiring_monthly_savingsnumberOptional

Monthly savings at risk from commitments expiring in the next 30 days

coveragenumber · nullableOptional

Overall commitment coverage ratio (0-1)

utilizationnumber · nullableOptional

Overall commitment utilization ratio (0-1)

purchase_missed_savingsnumberOptional

Monthly savings available by applying the recommended commitment plan. 0 if a plan has already been applied.

buyback_missed_savingsnumberOptional

Monthly savings available from pending buyback opportunities

purchase_automation_enabledbooleanOptional

Whether automatic commitment purchasing is enabled

buyback_automation_enabledbooleanOptional

Whether automatic buyback/sellback is enabled

has_actioned_planbooleanOptional

Whether the organization has ever applied a commitment plan

data_available_sincestring · date · nullableOptional

Earliest date cost data is available for this provider (null if no data)

get
/beta/v1/org/{org_id}/metrics/overview

Get daily coverage

get

Returns the mean commitment coverage over the requested date range, plus per-day values for trend analysis.

Path parameters
org_idstring · uuidRequired
Query parameters
providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:
segment_idstring · uuid · nullableOptional

Optional segment ID to scope results. Defaults to the provider resources segment if not specified.

Default: null
start_datestring · dateRequired

Start date (YYYY-MM-DD)

end_datestring · dateRequired

End date (YYYY-MM-DD, exclusive)

Responses
chevron-right
200

OK

application/json
period_startstringOptional

Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.

period_endstringOptional

Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).

coveragenumber · nullableOptional

Mean commitment coverage across the effective date range (0-1). Share of reservable spend covered by commitments.

get
/beta/v1/org/{org_id}/metrics/daily-coverage

Get daily savings

get

Returns daily commitment savings with cost and savings grouped, plus period-level totals.

Path parameters
org_idstring · uuidRequired
Query parameters
providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:
segment_idstring · uuid · nullableOptional

Optional segment ID to scope results. Defaults to the provider resources segment if not specified.

Default: null
start_datestring · dateRequired

Start date (YYYY-MM-DD)

end_datestring · dateRequired

End date (YYYY-MM-DD, exclusive)

Responses
chevron-right
200

OK

application/json
period_startstringOptional

Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.

period_endstringOptional

Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).

get
/beta/v1/org/{org_id}/metrics/daily-savings

Get daily reservable cost breakdown

get

Returns daily cost for reservable services over the date range, split by pricing type (on-demand, commitment-covered, spot). The commitment bucket is further split into cloud_provider_cost + archera_premium. Includes period-level totals and total savings vs on-demand baseline.

Path parameters
org_idstring · uuidRequired
Query parameters
providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:
segment_idstring · uuid · nullableOptional

Optional segment ID to scope results. Defaults to the provider resources segment if not specified.

Default: null
start_datestring · dateRequired

Start date (YYYY-MM-DD)

end_datestring · dateRequired

End date (YYYY-MM-DD, exclusive)

Responses
chevron-right
200

OK

application/json
period_startstringOptional

Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.

period_endstringOptional

Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).

total_costnumberOptional

Total paid for reservable services over the effective date range.

if_all_ondemand_costnumberOptional

On-demand baseline: what the range would cost at on-demand prices.

total_savingsnumberOptional

Total savings across all discount types (if_all_ondemand_cost - total_cost).

get
/beta/v1/org/{org_id}/metrics/daily-reservable-cost

Last updated

Was this helpful?