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

# Get experiments analytics summary

> Returns aggregated analytics summary for experiments.



## OpenAPI

````yaml /api-reference/rest-api-v4.yaml get /experiments/summary
openapi: 3.0.3
info:
  title: Qonversion REST API v4
  version: '4.0'
  description: >-
    Qonversion REST API v4 follows REST standards. It has predictable
    resource-oriented URLs, accepts JSON-encoded request bodies, returns
    JSON-encoded responses, and uses standard HTTP response codes,
    authentication, and verbs.
servers:
  - url: https://api.qonversion.io/v4
    description: Production
security:
  - secretAuth: []
tags:
  - name: Users
    description: Retrieve Qonversion users
  - name: User Properties
    description: Manage user-level attributes
  - name: Identities
    description: Link Qonversion users to your own auth IDs
  - name: Entitlements
    description: Entitlement definitions and user grants
  - name: Purchases
    description: A user's purchase history
  - name: Products
    description: Products configured in the Qonversion dashboard
  - name: Customers
    description: Aggregated customer records, properties, permissions, and metrics
  - name: Segments
    description: Dynamic and system segments of users
  - name: Experiments
    description: Paywall and offering A/B experiments
  - name: Screens
    description: No-code paywall screens — CRUD, publish, analytics
  - name: Analytics
    description: Charts, cards, cohorts, LTV, and insights
  - name: Exports
    description: Asynchronous data exports
  - name: Events
    description: Event catalog
  - name: Scheduled Reports
    description: Recurring reports delivered to external destinations
  - name: Integrations
    description: Third-party integrations configuration
  - name: Automations
    description: Event-driven automations
  - name: Project Settings
    description: Project-level configuration, secret, and store credentials
paths:
  /experiments/summary:
    get:
      tags:
        - Experiments
      summary: Get experiments analytics summary
      description: Returns aggregated analytics summary for experiments.
      operationId: v4GetExperimentsSummary
      parameters:
        - name: from
          in: query
          description: Start of the time range (ISO 8601).
          required: false
          schema:
            type: string
        - name: to
          in: query
          description: End of the time range (ISO 8601).
          required: false
          schema:
            type: string
        - name: environment
          in: query
          description: Filter by environment.
          required: false
          schema:
            type: string
        - name: summary_metric
          in: query
          description: Metric to summarize.
          required: false
          schema:
            type: string
        - name: currency
          in: query
          description: Currency code (ISO 4217).
          required: false
          schema:
            type: string
        - name: unit
          in: query
          description: Aggregation unit (e.g. day, week, month).
          required: false
          schema:
            type: string
        - name: week_starts_on
          in: query
          description: Day of week that a week starts on (e.g. monday, sunday).
          required: false
          schema:
            type: string
        - name: max_series
          in: query
          description: Maximum number of series to return.
          required: false
          schema:
            type: integer
        - name: filter[experiment_uid]
          in: query
          description: Filter by experiment UID.
          required: false
          schema:
            type: string
        - name: filter[experiment_uid][]
          in: query
          description: Filter by multiple experiment UIDs.
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Analytics summary data.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Experiments summary payload. `items` contains one entry per
                  experiment matched by `filter[experiment_uid][]`, with nested
                  `groups` carrying the group metadata (control flag, weight,
                  bound remote config).
              example:
                total_count: 1
                items:
                  - uid: a6a360a2-41ed-4964-b45a-ea1b0c3e3386
                    experiment_id: 210
                    project_id: 789
                    name: Paywall layout A/B
                    alias_id: paywall_layout_ab
                    desc: Compare two paywall layouts on iOS onboarding
                    segment_percent: 100
                    primary_metric: subscription-cancellation
                    goal_direction: decrease
                    goal_value: 4
                    context_key: ''
                    context_specific: false
                    status: finished
                    finished_at: 1712246400
                    created_at: 1709654400
                    updated_at: 1777051834
                    groups:
                      - uid: df0ab472
                        experiment_group_id: 407
                        experiment_id: 210
                        project_id: 789
                        name: Control group
                        control: 1
                        weight: 1
                        created_at: 1709654400
                        updated_at: 1709654400
                      - uid: 3c458035
                        experiment_group_id: 408
                        experiment_id: 210
                        project_id: 789
                        name: Test variant
                        control: 0
                        weight: 1
                        remote_config_uid: 25561136-dc1b-4625-9a05-0550d1a04508
                        created_at: 1709654400
                        updated_at: 1709655000
                        remote_config:
                          remote_config_uid: 25561136-dc1b-4625-9a05-0550d1a04508
                          project_id: 789
                          payload:
                            headline: Unlock Pro
                            cta: Start free trial
                          created_at: 1709654400
                          updated_at: 0
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '502':
          description: Upstream service failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '504':
          description: Upstream timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
      security:
        - secretAuth: []
components:
  schemas:
    V4Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - request
                - resource
                - logical
                - internal
            code:
              type: string
              description: |
                Machine-readable snake_case error code. Examples include
                `invalid_data`, `invalid_request`, `invalid_product_id`,
                `not_found`, `already_exists`, `offering_already_exists`,
                `product_not_in_project`, `cannot_set_main_directly`,
                `cannot_demote_main`, `cannot_patch_experiment_variant`,
                `cannot_delete_experiment_variant`, and
                `cannot_setmain_experiment_variant`. Resource-specific codes
                are documented on the corresponding reference page.
            message:
              type: string
              description: Human-readable description. May change; do not parse.
            details:
              type: array
              nullable: true
              description: Per-field validation errors, present on 400 validation failures.
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  securitySchemes:
    secretAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_…
      description: >-
        Bearer authentication using the project **Secret Key** (prefixed with
        `sk_`, or `test_sk_` for sandbox). All v4 public endpoints require the
        Secret Key — see [Authentication](/reference/v4/authentication). Never
        expose the Secret Key in client-side code.

````