List extended metrics

Returns a page of the extended metrics available to the customer:
the global extended metrics the customer's plan, tenant type, clouds,
integrations and data include, and the customer's DataHub metrics.
Use an item's key as value in metric: {type: extended, value: <key>}.

Where a key is accepted depends on its dataSource: a custom metric
variable takes a billing or billing-datahub key (filter with
dataSource:billing,billing-datahub), and a report or alert takes a
key of its own data source. A key that is not listed here gets
issue: extended_metric_not_found from create and update custom
metric.

Items are sorted by label, then key, then dataSource. A key
appears once per data source. rowCount is the exact number of
items that match filter, across all pages. The page token is
opaque and bound to filter: reusing it with a different filter
gets 400 pagination_token_invalid.

Errors (RFC 9457 Problem Details, code field):

  • 400 validation_failed: a bad parameter, such as maxResults
    over 500, or a dataSource filter value outside the data sources
    listed in ExtendedMetric.dataSource (issue: value_not_in_enum).
  • 400 filter_key_not_supported: a filter key other than
    dataSource. The details entry lists the supported keys in
    supportedKeys.
  • 400 pagination_token_invalid: see above.
  • 400 tenant_id_required: a caller with access to more than one
    customer sent no X-Tenant-Id.
  • 403 forbidden: no metrics read permission, or an X-Tenant-Id
    that the credential cannot access.
  • 503 service_unavailable: the extended metrics or the customer's
    plan could not be read. Retry after Retry-After seconds.

maxResults is at most 500. A larger value returns 400 validation_failed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
Defaults to 50

The maximum number of results to return in a single page. Use the page tokens to iterate through the entire collection.

string

Page token, returned by a previous call, to request the next page of results

string

Filter as key:value pairs, | between keys. Keys, operand
types and operators:

  • dataSource — one of billing, billing-datahub, bqlens,
    genai-collection, kubernetes-utilization and
    tokenomics; operator eq. Comma-separated values for OR.

Any other key returns 400 filter_key_not_supported. For
example dataSource:billing,billing-datahub lists the keys a
custom metric variable accepts. Percent-encode
,, |, : and spaces inside values.

Headers
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json