Skip to main content
GET
Get time series totals

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Query Parameters

name
string
required

Time series name

Example:

"login-flow-v1"

fromDate
string
required

Range start (inclusive) in UTC, formatted as YYYY-MM-DDTHH:MM:SS (e.g. "2026-05-20T09:30:00").

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$
Example:

"2026-05-20T09:30:00"

toDate
string
required

Range end (exclusive) in UTC, formatted as YYYY-MM-DDTHH:MM:SS. Must be after fromDate.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$
Example:

"2026-05-20T10:30:00"

groupBy
string

Comma-separated dimension keys to keep; all other dimensions are summed. Allowed: applicationId, browser, os, osVersion, customTag1..20, t1..t10, visitorType. Omitted returns a single total row.

Example:

"applicationId,t7"

narrow
boolean
default:true

Computes the part of the range that is not precalculated with a query grouped only by the groupBy dimensions, which is faster and returns the same totals. false runs the series' full query instead. Defaults to true.

explain
boolean
default:false

Adds queryPlan to the response: how the range was split and, for every part computed on demand, how its query was reduced to the groupBy dimensions. Defaults to false.

savedFilterID
string

Saved filter to apply (format svf-<number>), or none for unfiltered data. Omitted: the project's default saved filter (unfiltered when none is set). A saved filter given here replaces the default; it is never combined with it. The response's savedFilter says which filter was applied, or that it was not applicable to the series (then the data is unfiltered).

Example:

"svf-123456"

Response

Totals per dimension combination

savedFilter
object
required

Which saved filter shaped the response: none (none requested, or the project has no default), applied, or notApplicable when the data does not carry a dimension or custom tag the filter reads (listed in missing); then the data is returned unfiltered.

rows
object[]
required

One row per combination of the groupBy dimensions; empty when the range has no data

queryPlan
object

How the totals were computed; only returned with explain=true