measures: what to aggregate. A METRIC measure names its metric by slug; CONVERSATION counts conversations; UPTIME reads health checks. The aggregation defaults by the metric’s output type. - timeRange: LAST n DAYS/WEEKS/MONTHS, a CALENDAR_ALIGNED period (TODAY, THIS_MONTH, …), FIXED from/to, or SINCE. Defaults to the last 30 days; at most 731 days. Calendar periods and buckets align to timezone (IANA, default UTC). - filters apply to every measure; a measure’s own filters add to them. - breakdown on a measure returns one series per value (largest 50 kept). - comparisonGroups (2 to 5) run every measure once per named filter set; comparisonMode: PREVIOUS_PERIOD adds the preceding window’s values. Values are in the metric’s display units. A PASS_RATE is a 0 to 1 share; sampleSize 0 means no data. A query the analytics store cannot answer returns 400 naming the unsupported part.
Calls
POST /v1/analytics/queryOptions
array
required
What to aggregate: 1 to 10 measures.
array
Applied to every measure, on top of each measure’s own filters.
string
Bucket size. Defaults from the window’s length and steps coarser when the window would exceed 500 buckets. One of
HOUR, DAY, WEEK, MONTHstring
PREVIOUS_PERIOD adds the preceding window of the same length to every series. One of NONE, PREVIOUS_PERIODarray
Run every measure once per named filter set, e.g. one group per agent.
string
Defaults to the last 30 days.
string
IANA zone that buckets and calendar periods align to, e.g. America/New_York. Defaults to UTC.
switch
Set false to return only the window totals.