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

# Get analytics overview

> Returns key metrics, period comparisons, and trend data for the analytics dashboard.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/analytics/overview
openapi: 3.0.0
info:
  title: EngageFabric API
  description: >-
    EngageFabric is a multi-tenant SaaS gamification framework. This API
    provides endpoints for managing players, tracking events, quests,
    adventures, leaderboards, lobbies, and real-time features.
  version: 1.0.0
  contact:
    name: EngageFabric Support
    url: https://engagefabric.com
    email: support@engagefabric.com
  license:
    name: Proprietary
    url: https://engagefabric.com/terms
servers:
  - url: https://api.engagefabric.com
    description: Production
  - url: http://localhost:3000
    description: Development
security: []
tags:
  - name: auth
    description: Authentication endpoints
  - name: tenants
    description: Tenant management
  - name: projects
    description: Project management
  - name: players
    description: Player management and game state
  - name: events
    description: Event ingestion and tracking
  - name: quests
    description: Quest management and progress
  - name: adventures
    description: Adventure/season management
  - name: leaderboards
    description: Leaderboard rankings
  - name: lobbies
    description: Multiplayer lobby management
  - name: chat
    description: Real-time chat
  - name: rules
    description: Rules engine configuration
paths:
  /api/v1/analytics/overview:
    get:
      tags:
        - Analytics
      summary: Get analytics overview
      description: >-
        Returns key metrics, period comparisons, and trend data for the
        analytics dashboard.
      operationId: AnalyticsController_getOverview
      parameters:
        - name: projectId
          required: true
          in: query
          description: Project ID to get analytics for
          schema:
            type: string
            example: 550e8400-e29b-41d4-a716-446655440000
        - name: period
          required: false
          in: query
          description: Time period for analytics
          schema:
            default: 7d
            enum:
              - today
              - 7d
              - 30d
              - 90d
              - all
            type: string
      responses:
        '200':
          description: Analytics overview data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsOverviewResponse'
      security:
        - bearer: []
components:
  schemas:
    AnalyticsOverviewResponse:
      type: object
      properties:
        period:
          $ref: '#/components/schemas/AnalyticsPeriodInfo'
        overview:
          $ref: '#/components/schemas/AnalyticsOverviewMetrics'
        changes:
          $ref: '#/components/schemas/AnalyticsOverviewChanges'
        trends:
          $ref: '#/components/schemas/AnalyticsTrends'
      required:
        - period
        - overview
        - changes
        - trends
    AnalyticsPeriodInfo:
      type: object
      properties:
        start:
          type: string
          description: Start date (ISO 8601)
        end:
          type: string
          description: End date (ISO 8601)
        days:
          type: number
          description: Number of days in period
      required:
        - start
        - end
        - days
    AnalyticsOverviewMetrics:
      type: object
      properties:
        totalPlayers:
          type: number
          description: Total cumulative players
        activePlayers:
          type: number
          description: Players active in period
        newPlayers:
          type: number
          description: New players in period
        churnedPlayers:
          type: number
          description: Churned players (inactive 7+ days)
        averageLevel:
          type: number
          description: Average player level
        totalXpGranted:
          type: number
          description: Total XP granted in period
        questsCompleted:
          type: number
          description: Quests completed in period
        eventsProcessed:
          type: number
          description: Events processed in period
      required:
        - totalPlayers
        - activePlayers
        - newPlayers
        - churnedPlayers
        - averageLevel
        - totalXpGranted
        - questsCompleted
        - eventsProcessed
    AnalyticsOverviewChanges:
      type: object
      properties:
        totalPlayers:
          $ref: '#/components/schemas/MetricChange'
        activePlayers:
          $ref: '#/components/schemas/MetricChange'
        newPlayers:
          $ref: '#/components/schemas/MetricChange'
        questsCompleted:
          $ref: '#/components/schemas/MetricChange'
        eventsProcessed:
          $ref: '#/components/schemas/MetricChange'
      required:
        - totalPlayers
        - activePlayers
        - newPlayers
        - questsCompleted
        - eventsProcessed
    AnalyticsTrends:
      type: object
      properties:
        labels:
          description: Date labels for the x-axis
          type: array
          items:
            type: string
        players:
          description: Player counts per day
          type: array
          items:
            type: number
        xp:
          description: XP granted per day
          type: array
          items:
            type: number
        quests:
          description: Quests completed per day
          type: array
          items:
            type: number
        events:
          description: Events processed per day
          type: array
          items:
            type: number
      required:
        - labels
        - players
        - xp
        - quests
        - events
    MetricChange:
      type: object
      properties:
        value:
          type: number
          description: Absolute change value
        percentage:
          type: number
          description: Percentage change
      required:
        - value
        - percentage

````