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

# Get team overview

> Get team overview



## OpenAPI

````yaml get /api/v1/analytics/team/overview
openapi: 3.0.3
info:
  title: Xem API
  version: '1.0'
  description: Comprehensive API server for Xem email marketing platform
  contact: {}
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.xem.email/api/v1
    description: Production server
  - url: http://localhost:8080/api/v1
    description: Development server
security: []
tags:
  - name: Authentication
    description: User authentication and authorization endpoints
  - name: Teams
    description: Team management and collaboration features
  - name: Campaigns
    description: Email campaign creation, management, and tracking
  - name: Analytics
    description: Campaign analytics, audience insights, and performance metrics
  - name: Contacts
    description: Contact management and mailing list operations
  - name: Templates
    description: Email template management and customization
  - name: Automations
    description: Email automation workflows and triggers
  - name: SMTP
    description: SMTP configuration and email delivery settings
  - name: IMAP
    description: IMAP configuration for email inbox management
  - name: Webhooks
    description: Webhook management for real-time event notifications
  - name: Files
    description: File upload and management for attachments and media
  - name: Domains
    description: Domain management for email authentication
  - name: API Keys
    description: API key management for programmatic access
paths:
  /api/v1/analytics/team/overview:
    get:
      tags: []
      summary: Get team overview
      description: Get team overview
      parameters:
        - name: teamId
          in: query
          description: Team ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Team overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal_handlers.TeamOverview'
        '400':
          description: Validation error or team not found
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
      security: []
components:
  schemas:
    internal_handlers.TeamOverview:
      type: object
      properties:
        averageClickRate:
          type: number
        averageOpenRate:
          type: number
        deviceStats:
          type: object
          additionalProperties:
            type: integer
        geoStats:
          type: object
          additionalProperties:
            type: integer
        monthlyStats:
          type: array
          items:
            $ref: '#/components/schemas/internal_handlers.MonthlyEngagement'
        topCampaigns:
          type: array
          items:
            $ref: '#/components/schemas/internal_handlers.CampaignSummary'
        topPerformers:
          type: array
          items:
            $ref: '#/components/schemas/internal_handlers.PerformerMetrics'
        totalClicks:
          type: integer
        totalEmails:
          type: integer
        totalOpens:
          type: integer
    internal_handlers.MonthlyEngagement:
      type: object
      properties:
        clickRate:
          type: number
        month:
          type: string
        openRate:
          type: number
        totalEmails:
          type: integer
    internal_handlers.CampaignSummary:
      type: object
      properties:
        campaignId:
          type: string
        clickRate:
          type: number
        engagementScore:
          type: number
        name:
          type: string
        openRate:
          type: number
    internal_handlers.PerformerMetrics:
      type: object
      properties:
        engagementRate:
          type: number
        sampleSize:
          type: integer
        type:
          description: subject, template, time, etc.
          type: string
        value:
          type: string

````