v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Metrics

Tag Configuration Cardinality Estimator

Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™.

get/api/v2/metrics/{metric_name}/estimate

Path parameters

metric_namestring required

The name of the metric.

Query parameters

filter[groups]string

Comma-separated list of tag keys that the metric is configured to query with. For example: filter[groups]=app,host.

filter[hours_ago]integer

The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.

filter[num_aggregations]integer

Deprecated. Number of aggregations has no impact on volume.

filter[pct]boolean

A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.

filter[timespan_h]integer

A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.

Response

Success

Example response

{
  "data": {
    "attributes": {
      "estimate_type": "distribution",
      "estimated_at": "2022-04-27T09:48:37.463835Z",
      "estimated_output_series": 50
    },
    "id": "test.metric.latency",
    "type": "metric_cardinality_estimate"
  }
}