Interface MetricsApiEstimateMetricsOutputSeriesRequest

Hierarchy

  • MetricsApiEstimateMetricsOutputSeriesRequest

Properties

filterExcludeTagsMode? filterGroups? filterHoursAgo? filterNumAggregations? filterPct? filterTimespanH? metricName

Properties

Optional filterExcludeTagsMode

filterExcludeTagsMode?: boolean

When true, filter[groups] is treated as an exclude list instead of an include list. Defaults to false.

Optional filterGroups

filterGroups?: string

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

Optional filterHoursAgo

filterHoursAgo?: number

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

Optional filterNumAggregations

filterNumAggregations?: number

Deprecated. Number of aggregations has no impact on volume.

Optional filterPct

filterPct?: boolean

Deprecated. This query parameter has no effect on the estimate.

Optional filterTimespanH

filterTimespanH?: number

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

metricName

metricName: string

The name of the metric.

Settings

Member Visibility

Theme

Generated using TypeDoc