Get Kubernetes workload cost totals

post

https://api.doit.com/attribute/v1/workloads/{dimension}/stats

Returns aggregated totals for a date range: the total cost, the number of workloads, the
number of distinct dimension values (the row count of queryAttributeWorkloadsTable for
the same request), and the percent change of the total cost against the previous period of
the same length. Use this for "how much did workloads cost" or "how many namespaces", and
to know how many pages the table has. Use queryAttributeWorkloadsTable for the rows.

The request body holds the filters; this operation only reads data.

Freemium customers (no paid Attribute plan) see network cost only, and only for the last
60 days.

Authenticate with Authorization: Bearer <token>. Omit X-Tenant-Id when the credential
resolves to one customer. When the credential can act on several customers, send
X-Tenant-Id: <tenant-id> to select one.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

dimension

string

enum

required

What one row (or one series) stands for:

workload: one Kubernetes workload on one cluster. Only these rows carry workloadId,
the input of the /attribute/v1/workloads/w/* operations.
workloadName: all workloads with the same name, across clusters.
workloadType: one workload type.
namespace: one Kubernetes namespace.
platform: one cluster (name, type, region, account and cloud).
accountId: one cloud account that hosts clusters.
resource: one billed cloud resource used by workloads.
resourceType: one billed service.
costDescription: one billing SKU description.
platformCloudProvider: one cloud that clusters run on.

Query Params

from

date

required

First day of the date range (UTC), inclusive, as YYYY-MM-DD. The change fields compare
with the period of the same length right before this day. Freemium customers (no paid
Attribute plan) can only read the last 60 days: a from earlier than today minus 60 days
(UTC) returns 403.

date

required

Last day of the date range (UTC), inclusive, as YYYY-MM-DD. Must be on or after from.

signal

string

enum

Keeps only the workloads of one "needs attention" list from getAttributeWorkloadsSignals:
spike, new or network. The lists use their own fixed windows, not from and to;
from and to still decide which cost is shown. When the list is empty, no rows match.
Omit it to read all workloads.

Allowed:

Body Params

filterConditions

required

The filters, as an object with exactly one key: and (every item must match) or or (at
least one item must match). Each item is a condition or a group of conditions. Send
{"and": []} for no filter.

Headers

X-Tenant-Id

string

Customer (tenant) ID for the request. This is separate from authentication: you still pass your personal or service account API token in the Authorization header (Bearer <token>). See Get Started.

When to omit (most callers): If your personal or service account token belongs to a single customer, omit this header. The API resolves that customer from the token.

When to send: If your credential can access more than one customer, set X-Tenant-Id to the customer ID you want to act on. A service account can select an active direct or nested descendant of its home customer; the endpoint's normal permissions, entitlements, and resource-ownership checks still apply. A service-account target outside that customer subtree returns 403 Forbidden. Prefer this header over the legacy customerContext query parameter, which only applies to legacy API keys and is ignored by personal and service account tokens.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK - Totals for the date range.

401Unauthorized - The Authorization: Bearer <token> header is missing, the token is not valid, or the person behind the token has no email address. Code: unauthorized.

404Not Found - route_not_found when the path or HTTP method is not one of the Attribute Workloads operations. not_found when the workloadId does not decode: copy it unchanged from a workload row of queryAttributeWorkloadsTable.

409Conflict - The customer is not set up in Attribute yet (attribute_customer_not_provisioned) or its Attribute setup needs a fix by DoiT (attribute_tenant_reconciliation_required). Retrying does not help; contact DoiT support.

500Internal Server Error - Unexpected error in the Attribute service (upstream_error). Retry with backoff.

502Bad Gateway - A service behind the gateway did not answer: token check (auth_unavailable) or the Attribute service (upstream_unavailable), or the Attribute service refused the gateway (upstream_error). Retry with backoff.

503Service Unavailable - The Attribute integration is turned off (integration_disabled), the token check is unavailable (auth_unavailable), or the permission check is unavailable (authorization_unavailable). Retry later.