Skip to content

SeriesQuery

Defined in: packages/client/src/specs.ts:65

A metric over time, optionally split by one dimension.

optional filters?: readonly Filter[]

Defined in: packages/client/src/specs.ts:76

Up to 10.


optional groupBy?: Dimension

Defined in: packages/client/src/specs.ts:73


interval: "day" | "week" | "month" | "minute" | "hour"

Defined in: packages/client/src/specs.ts:72

Minute series cover 2 days at most, hourly series 31.


kind: "series"

Defined in: packages/client/src/specs.ts:66


optional limit?: number

Defined in: packages/client/src/specs.ts:80

With groupBy: how many of its values to keep, the busiest first. 1 to 20, default 10.


metric: SeriesMetric

Defined in: packages/client/src/specs.ts:67


optional name?: string

Defined in: packages/client/src/specs.ts:69

For metric: 'custom': the event’s name.


range: TimeRange

Defined in: packages/client/src/specs.ts:70


optional stat?: Stat

Defined in: packages/client/src/specs.ts:74


optional timezone?: string

Defined in: packages/client/src/specs.ts:78

IANA name the points are cut in. Default 'UTC'.