UMumbrellacost
Assets

Get Cost Assets

Retrieve the list of assets defined in the account

get/api/v2/usage/assets

Request

  • Base URL
    https://api.umbrellacost.io
  • URL
    https://api.umbrellacost.io/api/v2/usage/assets
  • Auth
    none declared. Required headers: Authorization, apikey

Query parameters

startDatestring date required

Start date for getting the data

endDatestring date required

End date for getting the data

granLevelstring required

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

columnsstring required

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

dimstring

All the filtering options can be found here: https://docs.umbrellacost.io/reference/groupby-and-filtering-options

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

dimstring

All the filtering options can be found here: https://docs.umbrellacost.io/reference/groupby-and-filtering-options

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

dimstring

All the filtering options can be found here: https://docs.umbrellacost.io/reference/groupby-and-filtering-options

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

dimstring

All the filtering options can be found here: https://docs.umbrellacost.io/reference/groupby-and-filtering-options

Negated substring filters. excludeLikeFilters[dim]=value

isK8Sboolean

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)

costTypestring

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

k8sCostTypestring

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

measurementsstring

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

isUnblendedboolean required

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

conjunctionstring

How multiple filters combine (and / or).

includeCustomerCostboolean

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

tokenstring

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

Headers

Authorizationstring required
apikeystring required

Response

usageDatestring
payeraccountstring
servicestring
totalcostinteger
totalUsageQuantityinteger

Changes

No recorded changes to this operation across all 1 revision of this API.