Cost Explorer (Beta)

Total cloud spend exploration

Explore total cloud spend

get

Returns total cloud spend over a date range, optionally grouped by service, account, or region. Includes all cost types (not just reservable). Data comes from cloud provider Cost Explorer APIs.

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)

group_bystring · enum · nullableOptional

Dimension to group costs by: 'service', 'account', or 'region'. If omitted, returns total spend without grouping.

Default: nullPossible values:
granularitystring · enumOptional

Time granularity: 'daily' or 'monthly' (default 'daily')

Default: dailyPossible values:
metricstring · enumOptional

Cost metric to use. 'amortized' (default): includes upfront costs spread over commitment term. 'unblended' (AWS only): actual charges as they appear on the bill. 'actual' (Azure/GCP only): equivalent to unblended for Azure and GCP.

Default: amortizedPossible values:
top_ninteger · min: 1 · nullableOptional

Return only the top N groups by cost, with remaining groups combined into 'Other'. If omitted, returns all groups.

Default: null
include_discounts_and_creditsbooleanOptional

Include credits, refunds, and enterprise discounts (AWS EDP/PPA, Azure MACC, GCP commit agreements) in the cost data. Default false (shows spend before credits and discounts).

Default: false
include_time_seriesbooleanOptional

Include time-series data points for each group. Default true. Set to false for compact summary-only responses.

Default: true
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 cost across all groups over the effective date range. Headline 'cost' — the answer to 'what did I spend.' Sum of groups[*].total_cost.

get
/beta/v1/org/{org_id}/cost-explorer

Get available cost-explorer filter fields and values

get

Returns the valid filter fields and their possible values for building cost-explorer filter parameters. Field names in the response can be used directly as the 'field' value in filter expressions.

Path parameters
org_idstring · uuidRequired
Query parameters
providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:
Responses
chevron-right
200

OK

application/json
servicestring[]Optional

Available cloud service names

account_idstring[]Optional

Available cloud account IDs

regionstring[]Optional

Available cloud regions

instance_familystring[]Optional

Available instance families (AWS only)

operating_systemstring[]Optional

Available operating systems (AWS only)

tenancystring[]Optional

Available tenancy types (AWS only)

get
/beta/v1/org/{org_id}/cost-explorer/filters

Last updated

Was this helpful?