Upstash Documentation

$stats

1 min read

$stats returns multiple basic metrics in one pass.

For the selected field, it computes:

  • count
  • sum
  • min
  • max
  • avg

This is equivalent to running $count, $sum, $min, $max, and $avg together, but returned as a single object.

Compatibility#

Field TypeSupported
TEXTNo
U64/I64/F64Yes
DATEYes
BOOLYes
KEYWORDNo
FACETNo

Field must be FAST.

Arguments#

ArgumentTypeRequiredDescription
fieldstringYesField to aggregate.
missingnumberNoFallback value for missing fields.

Output#

min, max, and avg can be null when no values are available.