External Costs API
External Costs can only be queried after you have configured at least one external service with Kubecost. You can learn how to integrate Datadog through this method in our External Costs doc.
External Costs API summary query
GET
http://<your-kubecost-address>/model/customCost/timeseries
Samples costs of connected third party services
Path Parameters
window*
String
Duration of time over which to query. Accepts multiple different formats of time (see this Using the window
parameter section for more info).
aggregate
String
Field by which to aggregate the results. Accepts: zone
, accountName
, chargeCategory
, description
, resourceName
, resourceType
, providerId
, usageUnit
, domain
, and costSource
. Supports multi-aggregation using comma-separated lists. Example: aggregate=zone,description
accumulate
boolean
When set to false
, this endpoint returns daily time series data vs cumulative data. Default value is false
.
filter
String
Filter your results by any category which you can aggregate by, can support multiple filterable items in the same category in a comma-separated list. For example, to filter results by charge categories usage
and billing
, use filter=chargeCategory:usage,billing
See our Filter Parameters doc for a complete explanation of how to use filters and what categories are supported.
External Costs API total query
GET
http://<your-kubecost-address>/model/customCost/total
Samples costs of connected third party services, but summarizes subwindows into singular window of total cost. Can be compared to /topline
endpoint of other APIs.
Path Parameters
window*
String
Duration of time over which to query. Accepts multiple different formats of time (see this Using the window
parameter section for more info).
aggregate
String
Field by which to aggregate the results. Accepts: zone
, accountName
, chargeCategory
, description
, resourceName
, resourceType
, providerId
, usageUnit
, domain
, and costSource
. Supports multi-aggregation using comma-separated lists. Example: aggregate=zone,description
accumulate
boolean
When set to false
, this endpoint returns daily time series data vs cumulative data. Default value is false
.
filter
String
Filter your results by any category which you can aggregate by, can support multiple filterable items in the same category in a comma-separated list. For example, to filter results by charge categories usage
and billing
, use filter=chargeCategory:usage,billing
See our Filter Parameters doc for a complete explanation of how to use filters and what categories are supported.
Last updated