Get Cost Assets

get

https://api.umbrellacost.io/api/v2/usage/assets

Retrieve the list of assets defined in the account

✅
Use this API to get K8s and non-K8s cost assets.
Set the isK8S parameter to "1" to get K8s assets.
The possible combinations of the columns / cost types vary between the two use cases.

ℹ️
Columns and filter names
Review all the dimensions available for the filters and columns selection in the following link.

Pagination

The nextToken field will be included in the response to indicate there is additional information to retrieve.
The value should be used in the token parameter of the next call.

Query Params

startDate

date

required

Start date for getting the data

endDate

date

required

End date for getting the data

granLevel

string

required

Granularity level of the period in the output data. (enum. Possible values: month, week, day)

columns

string

required

The different columns for the required assets.
Review optional values in: https://docs.umbrellacost.io/reference/grouping-anf-filtering-options

filters

object

Include-filters keyed by dimension.
filters[dim]=value
Review optional values in: https://docs.umbrellacost.io/reference/grouping-anf-filtering-options

excludeFilters

object

Exclude-filters, same shape as filters.
excludeFilters[dim]=value

likeFilters

object

Substring (LIKE) filters.
likeFilters[dim]=value

excludeLikeFilters

object

Negated substring filters.
excludeLikeFilters[dim]=value

isK8S

boolean

A flag indicating whether to get cloud and k8s data or just K8s.
isK8s = 1 : only K8s cost
isK8s = 0 : cloud and K8s cost (default)

costType

string

The different cost types for the required assets. Possible options are: cost, discount, refund, credit.

k8sCostType

string

Relevant for K8s cost (isK8s = 1), the possible options are: compute, network, storage, and dataTransfer.

measurements

string

can be one or more measurement.
Optional values: unblended_total_cost, distributed_total_cost, public_total_cost, net_unblended_total_cost, net_amortized_total_cost, amortized_total_cost

isUnblended

boolean

required

Should the returned data be unblended. (See additional options in the note above)

conjunction

string

How multiple filters combine (and / or).

includeCustomerCost

boolean

For MSPs only.
includeCustomerCost = 0 : only partner cost.
includeCustomerCost = 1 : customer and partner costs.

token

string

Pagination indicator. The next token to return in this call. This will be returned from the previous call to this API.

Headers

Authorization

string

required

apikey

string

required

Response

200