{% swagger method="get" path="/assets/query" baseUrl="http://app.kubecost.com/query" summary="Assets API (Querying)" %} {% swagger-description %} The Assets API retrieves backing cost data broken down by individual assets in your cluster but also provides various aggregations of this data. {% endswagger-description %}
{% swagger-parameter in="path" name="window" required="true" type="string" %}
Duration of time over which to query. Accepts multiple formats including units of time, relative time units, and unix timestamps. See this section on using the window parameter for more information.
{% endswagger-parameter %}
{% swagger-parameter in="path" name="format" type="string" required="false" %}
File type when exporting query. Currently only supports json.
{% endswagger-parameter %}
{% swagger-parameter in="path" name="aggregate" type="string" required="false" %}
Used to consolidate cost model data. Supported values are account, category, cluster, name, project, providerid, provider, service, type, department, environment, owner, product, team, and label:<name>. Passing an empty value for this parameter or none at all returns data by an individual asset. Supports multi-aggregation (aggregation of multiple categories) in a comma separated list, such as aggregate=account,project.
{% endswagger-parameter %}
{% swagger-parameter in="path" name="accumulate" type="boolean" required="false" %}
If true, sum the entire range of time intervals into a single set. Default value is false.
{% endswagger-parameter %}
{% swagger-parameter in="path" name="limit" type="int" required="false" %}
Refers to the number of line items per page. Currently, only supported together with accumulate=true to obtain a single list of line items.
{% endswagger-parameter %}
{% swagger-parameter in="path" name="filter" type="string" required="false" %}
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 clusters A and B, use filter=cluster:clusterA,clusterB See our Filter Parameters doc for a complete explanation of how to use filters and what categories are supported.
{% endswagger-parameter %}
{% endswagger %}
{% swagger method="get" path="/assets/totals" baseUrl="http://app.kubecost.com/query" summary="Assets API (Total)" %}
{% swagger-description %}
The /totals endpoint does not aggregate, and accepts only a window and an optional filter, returning a single total cost.
{% endswagger-description %}
{% swagger-parameter in="path" name="window" type="string" required="true" %}
Duration of time over which to query. Accepts multiple formats including units of time, relative time units, and unix timestamps. See this section on using the window parameter for more information.
{% endswagger-parameter %}
{% swagger-parameter in="path" name="format" type="string" required="false" %}
File type when exporting query. Currently only supports json.
{% endswagger-parameter %}
{% swagger-parameter in="path" name="filter" type="string" required="false" %}
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 clusters A and B, use filter=cluster:clusterA,clusterB See our Filter Parameters doc for a complete explanation of how to use filters and what categories are supported.
{% endswagger-parameter %}
{% endswagger %}