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

# Read bucketed analytics over a date range



## OpenAPI

````yaml /api-reference/openapi.json get /v1/analytics/timeseries
openapi: 3.0.3
info:
  description: Public REST API for embedding Expys experiences into a client app.
  title: Expys API
  version: 1.2.0
servers:
  - url: https://api.expys.com
    description: >-
      Expys API. Sandbox and live share this host; the environment is selected
      by which key you exchange for a member token, not by the URL.
security: []
paths:
  /v1/analytics/timeseries:
    get:
      tags:
        - Analytics
      summary: Read bucketed analytics over a date range
      operationId: getAnalyticsTimeseries
      parameters:
        - in: query
          name: from
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: to
          required: true
          schema:
            format: date-time
            type: string
        - in: query
          name: interval
          required: true
          schema:
            enum:
              - day
              - week
              - month
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAnalyticsTimeseriesResponse'
          description: Response for status 200
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '401':
          description: Authentication is missing or invalid.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '403':
          description: Authenticated, but not permitted to access this resource.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '429':
          description: Rate limit exceeded; honor the Retry-After header.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
        '500':
          description: An unexpected server error occurred.
          headers:
            X-Request-Id:
              description: >-
                Per-request correlation id. Quote it to support to trace the
                call in the server logs.
              schema:
                type: string
      security:
        - ApiKeyBearer: []
        - ApiKeyHeader: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl https://api.expys.com/v1/analytics/timeseries \
              -H "Authorization: Bearer YOUR_ORG_API_KEY"
components:
  schemas:
    GetAnalyticsTimeseriesResponse:
      properties:
        buckets:
          items:
            $ref: '#/components/schemas/TimeseriesBucket'
          type: array
      required:
        - buckets
      type: object
    TimeseriesBucket:
      properties:
        endTime:
          type: string
        pointsMinted:
          type: number
        pointsSpent:
          type: number
        signups:
          type: number
        startTime:
          type: string
      required:
        - endTime
        - pointsMinted
        - pointsSpent
        - signups
        - startTime
      type: object
  securitySchemes:
    ApiKeyBearer:
      description: Org-API-Key as a Bearer token.
      scheme: bearer
      type: http
    ApiKeyHeader:
      description: Org-API-Key as a header.
      in: header
      name: x-api-key
      type: apiKey

````