v1
latestOpenAPI 3.0.32026-07-26191565482.4 KBMetricUsagesByMetricName
get/api/v1/state/metric-usages-by-metric-name
Query parameters
page.max_sizeinteger
Sets the preferred number of items to return per page. If set to 0, the server will use its default value. Regardless of the value specified, clients must never assume how many items will be returned.
page.tokenstring
An opaque page token that identifies which page the client should request. An empty value indicates the first page.
order.ascendingboolean
order.by'VALUABLE' | 'DPPS' | 'UTILITY' | 'REFERENCES' | 'EXECUTIONS' | 'UNIQUE_VALUES' | 'UNIQUE_USERS'
lookback_secsinteger
Controls the time range over which query executions are included in usages. Defaults to 2592000 (30 days).
metric_name_globstring
Glob match string for filtering results by metric name.
include_counts_by_typeboolean
If true, responses include the fields reference_counts_by_type and query_execution_counts_by_type. If false, these fields are returned empty.
Response
A successful response.