Upstash Documentation

Overview

1 min read

Metric aggregations compute summary numbers over all documents that matched your filter.

Use metrics when you want one value (or stats object), not grouped buckets.

Available Operators#

OperatorWhat it computes
$avgArithmetic mean
$sumTotal of values
$minSmallest value
$maxLargest value
$countCount of values
$cardinalityCount of distinct values
$statscount, sum, min, max, avg
$extendedStats$stats + variance and std deviation metrics
$percentilesDistribution percent points

Input Format#

Every metric operator takes an object with at least a field property:

The field value must be a string pointing to a FAST field in your schema.

Behavior Notes#

  • Metric operators require a field.
  • The field must be FAST in your schema.
  • Metric operators do not support nested $aggs.
  • For many metric operators, missing lets you provide a fallback value for documents where the field does not exist.