> ## 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.

# Request export

> Initiates an async data export job. Returns export ID for status polling.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/analytics/export
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/export:
    post:
      tags:
        - Analytics
      summary: Request export
      description: >-
        Initiates an async data export job. Returns export ID for status
        polling.
      operationId: AnalyticsController_requestExport
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportRequestDto'
      responses:
        '202':
          description: Export job started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportRequestResponse'
      security:
        - bearer: []
components:
  schemas:
    ExportRequestDto:
      type: object
      properties:
        projectId:
          type: string
          description: Project ID to export data from
          example: 550e8400-e29b-41d4-a716-446655440000
        dataType:
          type: string
          description: Type of data to export
          enum:
            - players
            - events
            - quests
            - overview
            - retention
          example: overview
        format:
          type: string
          description: Export format
          enum:
            - csv
            - json
          default: csv
        startDate:
          type: string
          description: Start date for export range (ISO 8601)
          example: '2025-01-01T00:00:00Z'
        endDate:
          type: string
          description: End date for export range (ISO 8601)
          example: '2025-12-31T23:59:59Z'
      required:
        - projectId
        - dataType
    ExportRequestResponse:
      type: object
      properties:
        exportId:
          type: string
          description: Export job ID
        status:
          type: string
          enum:
            - processing
            - completed
            - failed
          description: Current export status
        estimatedSeconds:
          type: number
          description: Estimated completion time in seconds
      required:
        - exportId
        - status
        - estimatedSeconds

````