Skip to main content
GET
/
api
/
v1
/
state
/
metric-usages-by-metric-name
{
  "page": {
    "next_token": "<string>"
  },
  "usages": [
    {
      "dpps": 123,
      "metric_name": "<string>",
      "usage": {
        "query_execution_counts_by_type": {
          "dashboard": 123,
          "explorer": 123,
          "external": 123
        },
        "reference_counts_by_type": {
          "aggregation_rules": 123,
          "dashboards": 123,
          "drop_rules": 123,
          "monitors": 123,
          "recording_rules": 123
        },
        "total_query_executions": 123,
        "total_references": 123,
        "total_unique_users": 123,
        "utility_score": 123
      }
    }
  ]
}

Authorizations

​
API-Token
string
header
required

Chronosphere API token

Query Parameters

​
page.max_size
integer<int64>

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.token
string

An opaque page token that identifies which page the client should request. An empty value indicates the first page.

​
order.ascending
boolean
​
order.by
enum<string>
Available options:
VALUABLE,
DPPS,
UTILITY,
REFERENCES,
EXECUTIONS,
UNIQUE_VALUES,
UNIQUE_USERS
​
lookback_secs
integer<int32>

Controls the time range over which query executions are included in usages. Defaults to 2592000 (30 days).

​
metric_name_glob
string

Glob match string for filtering results by metric name.

​
include_counts_by_type
boolean

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.

​
page
object
​
usages
object[]