> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corbado.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get time series totals

> Sums a time series over an arbitrary range, one row per combination of the `groupBy` dimensions
and without time buckets. Every dimension not listed in `groupBy` is summed away, so omitting
`groupBy` returns a single row with the total.

The range does not have to align with any hour or day. Recent data that is not yet precalculated
is computed on demand; that part of the range must not exceed 8 hours, otherwise the request is
rejected with a validation error.

Only meaningful for series whose values are counts, because values are added up across buckets.

Required API key permission: `observe:timeSeries:read`.



## OpenAPI

````yaml /api-reference/openapi/observe.yaml get /observe/timeSeries/totals
openapi: 3.1.1
info:
  version: 1.0.0
  title: Corbado API
  description: >
    # Introduction

    This documentation gives an overview of all Corbado API calls to implement
    authentication observe.
  contact:
    name: Corbado team
    email: support@corbado.com
    url: https://www.corbado.com
servers:
  - url: https://api.cloud.corbado.io/v1
security:
  - bearerAuth: []
tags:
  - name: ObserveFlow
    description: Flow search and related APIs
    x-group: Journeys and users
  - name: ObserveSubFlow
    description: Subflow search and related APIs
    x-group: Journeys and users
  - name: ObserveUser
    description: User search and related APIs
    x-group: Journeys and users
  - name: ObserveIdentifier
    description: Identifier search over submitted identifiers
    x-group: Journeys and users
  - name: ObserveClientEnv
    description: Client environment search APIs
    x-group: Journeys and users
  - name: ObserveTimeSeries
    description: Time series query APIs
    x-group: Metrics and funnels
  - name: ObserveFunnel
    description: Historical funnel metrics, dictionaries and coverage.
    x-group: Metrics and funnels
  - name: ObserveEvent
    description: Event ingestion and event feed APIs
    x-group: Events
  - name: ObserveError
    description: Named authentication errors and recommendations.
    x-group: Error management
  - name: ObserveErrorFlavour
    description: Error variants and their impact on authentication outcomes.
    x-group: Error management
  - name: ObserveFinding
    description: Curated findings that explain errors, their impact and who has to act.
    x-group: Error management
  - name: ObserveAlert
    description: Authentication alert rules, instances and history.
    x-group: Alert management
  - name: ObserveAnnotation
    description: Annotation APIs (dated notes for analytics context)
    x-group: Annotations
  - name: ObserveTableExport
    description: Table export file listing and download APIs
    x-group: Data exports
  - name: ObserveTimeSeriesExport
    description: Time-series export generation and downloads.
    x-group: Data exports
  - name: ObserveDataExport
    description: Data export APIs
    x-group: User data
  - name: ObserveDataDeletionJob
    description: Data deletion job APIs
    x-group: User data
  - name: ObserveFlowTypeDefinition
    description: Flow type definitions used in authentication journeys.
    x-group: Catalogs and labels
  - name: ObserveCatalog
    description: Catalog APIs
    x-group: Catalogs and labels
  - name: OpenAPI
    description: Downloadable API specification
  - name: ProjectOperationExecution
    description: Project-scoped operation history and pipeline health
  - name: ObserveClassification
    description: Flow and subflow classification APIs
  - name: ObserveIntegrationStats
    description: Integration stats APIs
  - name: ObserveTimeSeriesPrecalculation
    description: Time series precalculation APIs
  - name: ObserveIDList
    x-group: Saved ID lists
    description: Stored ID-list selection APIs
  - name: ObserveDataContext
    description: Schema-loose data context APIs for agent and debugging tooling
  - name: ObserveData
    description: Observe data administration APIs
  - name: ObserveTrackingStats
    description: Tracking ingestion stats APIs
  - name: ObserveExperiment
    x-group: Experiments
    description: Experiment catalog and run APIs
  - name: ObserveDataPolicy
    description: >-
      Project data policy catalogue (retention selected by the SDK's
      meta.dataPolicy code)
  - name: ObserveMetadata
    x-group: Metadata
    description: Authenticator metadata APIs (FIDO MDS + passkey AAGUID)
  - name: ObservePasskey
    x-group: Passkey analysis
    description: Observed passkey search and cohort analysis.
paths:
  /observe/timeSeries/totals:
    get:
      tags:
        - ObserveTimeSeries
      summary: Get time series totals
      description: >-
        Sums a time series over an arbitrary range, one row per combination of
        the `groupBy` dimensions

        and without time buckets. Every dimension not listed in `groupBy` is
        summed away, so omitting

        `groupBy` returns a single row with the total.


        The range does not have to align with any hour or day. Recent data that
        is not yet precalculated

        is computed on demand; that part of the range must not exceed 8 hours,
        otherwise the request is

        rejected with a validation error.


        Only meaningful for series whose values are counts, because values are
        added up across buckets.


        Required API key permission: `observe:timeSeries:read`.
      operationId: ObserveTimeSeriesTotalsGet
      parameters:
        - name: name
          in: query
          required: true
          description: Time series name
          schema:
            type: string
            example: login-flow-v1
          x-oapi-codegen-extra-tags:
            validate: required
        - name: fromDate
          in: query
          required: true
          description: >-
            Range start (inclusive) in UTC, formatted as YYYY-MM-DDTHH:MM:SS
            (e.g. "2026-05-20T09:30:00").
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$
            example: '2026-05-20T09:30:00'
          x-oapi-codegen-extra-tags:
            validate: required,datetime=2006-01-02T15:04:05
        - name: toDate
          in: query
          required: true
          description: >-
            Range end (exclusive) in UTC, formatted as YYYY-MM-DDTHH:MM:SS. Must
            be after fromDate.
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$
            example: '2026-05-20T10:30:00'
          x-oapi-codegen-extra-tags:
            validate: required,datetime=2006-01-02T15:04:05
        - name: groupBy
          in: query
          required: false
          description: >
            Comma-separated dimension keys to keep; all other dimensions are
            summed. Allowed: applicationId, browser, os, osVersion,
            customTag1..6, t1..t10. Omitted returns a single total row.
          schema:
            type: string
            example: applicationId,t7
          x-oapi-codegen-extra-tags:
            validate: omitempty
        - name: narrow
          in: query
          required: false
          description: >
            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.
          schema:
            type: boolean
            default: true
        - name: explain
          in: query
          required: false
          description: >
            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.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Totals per dimension combination
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observeTimeSeriesTotalsGetRsp'
        '404':
          description: Time series not enabled for the project
        '429':
          description: Live read capacity is busy, retry later
        '504':
          description: Live read timed out, reduce the range
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth:
            - observe:timeSeries:read
components:
  schemas:
    observeTimeSeriesTotalsGetRsp:
      type: object
      required:
        - rows
      properties:
        rows:
          type: array
          description: >-
            One row per combination of the groupBy dimensions; empty when the
            range has no data
          items:
            $ref: '#/components/schemas/observeTimeSeriesTotalsRow'
        queryPlan:
          $ref: '#/components/schemas/observeTimeSeriesTotalsQueryPlan'
    observeTimeSeriesTotalsRow:
      type: object
      required:
        - dimensions
        - value
      properties:
        dimensions:
          type: object
          description: >-
            Values of the groupBy dimensions; a dimension without a value is
            omitted
          additionalProperties:
            type: string
        value:
          type: number
          format: double
          description: Sum over the range
    observeTimeSeriesTotalsQueryPlan:
      type: object
      description: How the totals were computed; only returned with explain=true
      required:
        - segments
      properties:
        segments:
          type: array
          description: Contiguous parts of the range, oldest first
          items:
            $ref: '#/components/schemas/observeTimeSeriesTotalsQueryPlanSegment'
    errorRspV2:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              description: Error message
              type: string
              example: Validation failed
            details:
              description: Validation error details per field
              type: array
              items:
                type: object
                required:
                  - field
                  - message
                properties:
                  field:
                    description: Field name that failed validation
                    type: string
                    example: projectID
                  message:
                    description: Validation error message
                    type: string
                    example: required
    observeTimeSeriesTotalsQueryPlanSegment:
      type: object
      required:
        - source
        - fromMs
        - toMs
      properties:
        source:
          type: string
          enum:
            - stored
            - live
          description: stored reads precalculated data, live computes the segment on demand
        interval:
          $ref: '#/components/schemas/observeTimeSeriesInterval'
        fromMs:
          type: integer
          format: int64
          description: Segment start (inclusive) as Unix milliseconds
        toMs:
          type: integer
          format: int64
          description: Segment end (exclusive) as Unix milliseconds
        narrowed:
          type: boolean
          description: Live segments. The query was reduced to the groupBy dimensions.
        reason:
          type: string
          description: >-
            Live segments. Why the query was not reduced, or why all of its
            joins were kept.
        groupBy:
          type: array
          description: Live segments. Columns the reduced query groups by.
          items:
            type: string
        removedFields:
          type: array
          description: Live segments. Columns removed from the query.
          items:
            type: string
        removedJoins:
          type: array
          description: Live segments. Joined tables removed from the query, by alias.
          items:
            type: string
        keptJoins:
          type: array
          description: Live segments. Joined tables kept in the query, by alias.
          items:
            type: string
    observeTimeSeriesInterval:
      type: string
      enum:
        - hourly
        - daily
        - monthly
      description: Aggregation interval for the time series
  responses:
    error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorRspV2'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.