> ## 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 per-screen analytics

> Returns analytics metrics for a single screen.
Supports optional time-range, environment, currency, and unit filters.




## OpenAPI

````yaml /api-reference/rest-api-v4.yaml get /screens/{screen_id}/analytics
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:
  /screens/{screen_id}/analytics:
    get:
      tags:
        - Screens
      summary: Get per-screen analytics
      description: |
        Returns analytics metrics for a single screen.
        Supports optional time-range, environment, currency, and unit filters.
      operationId: v4GetScreenAnalytics
      parameters:
        - name: screen_id
          in: path
          required: true
          description: Screen identifier.
          schema:
            type: string
            pattern: ^[a-zA-Z0-9._-]+$
            maxLength: 256
          example: scr_abc123
        - name: from
          in: query
          description: Start of the analytics period (ISO 8601 date or datetime).
          required: false
          schema:
            type: string
            example: '2025-01-01'
        - name: to
          in: query
          description: End of the analytics period (ISO 8601 date or datetime).
          required: false
          schema:
            type: string
            example: '2025-12-31'
        - name: environment
          in: query
          description: Filter by environment.
          required: false
          schema:
            type: string
            x-extensible-enum:
              - production
              - sandbox
        - name: currency
          in: query
          description: Currency code for revenue metrics (ISO 4217).
          required: false
          schema:
            type: string
            example: USD
        - name: unit
          in: query
          description: Time unit for grouping analytics data.
          required: false
          schema:
            type: string
            x-extensible-enum:
              - day
              - week
              - month
      responses:
        '200':
          description: Analytics data for the specified screen.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Analytics object wrapped in the standard v4 envelope (object,
                  url, data). `data.kpis` uses snake_case keys (conversion_rate,
                  cancel_rate) and each KPI carries value, previous-period
                  value, and a sparkline.
                additionalProperties: true
              example:
                object: screen_analytics
                url: /v4/screens/scr_abc123/analytics
                data:
                  kpis:
                    purchases:
                      value: 42
                      prev: 38
                      sparkline:
                        - 5
                        - 6
                        - 5
                        - 7
                        - 6
                        - 6
                        - 7
                    trials:
                      value: 215
                      prev: 198
                      sparkline:
                        - 28
                        - 31
                        - 30
                        - 32
                        - 31
                        - 31
                        - 32
                    revenue:
                      value: 840.15
                      prev: 760.4
                      sparkline:
                        - 105
                        - 118
                        - 112
                        - 128
                        - 120
                        - 122
                        - 135.15
                    refunds:
                      value: 2
                      prev: 1
                      sparkline:
                        - 0
                        - 0
                        - 1
                        - 0
                        - 0
                        - 0
                        - 1
                    conversion_rate:
                      value: 0.195
                      prev: 0.192
                      sparkline:
                        - 0.18
                        - 0.19
                        - 0.2
                        - 0.19
                        - 0.2
                        - 0.2
                        - 0.21
                    cancel_rate:
                      value: 0.045
                      prev: 0.052
                      sparkline:
                        - 0.06
                        - 0.05
                        - 0.05
                        - 0.04
                        - 0.04
                        - 0.04
                        - 0.04
                  period:
                    from: 1776447033
                    to: 1777051833
                    unit: day
                  screen:
                    uid: scr_abc123
                    name: Premium paywall
                    status: published
                    type: paywall
        '400':
          description: Invalid screen_id or parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '404':
          description: Screen not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '500':
          description: Internal error
          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.

````