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

# Get scheduler analytics summary

> Summary Simple Scheduler stats for today, this week, and this month. Requires the `read:scheduler_analytics` permission.



## OpenAPI

````yaml /api-reference/openapi.json get /api/scheduler-analytics/summary
openapi: 3.1.0
info:
  title: Avoca Enterprise API
  description: >-
    Read-only programmatic access to Avoca data: calls, transcripts, leads,
    coach evaluations, Simple Scheduler sessions and analytics, and outbound
    texting activity.
  version: 1.3.0
servers:
  - url: https://enterprise-api.avoca.ai
security:
  - bearerAuth: []
tags:
  - name: Calls
    description: Call records, transcripts, and pre-call transfers
  - name: Leads
    description: Unified leads (v0) and the canonical leads feed (v1)
  - name: Teams
    description: Teams accessible to the API key
  - name: Coach
    description: Coach (QA) call evaluations and rubrics
  - name: Scheduler Analytics (v0)
    description: Simple Scheduler analytics — legacy flat endpoints
  - name: Sessions & Bookings
    description: v1 scheduling-widget sessions and completed bookings
  - name: Analytics (v1)
    description: v1 funnel, UTM, service-area, and issue-type analytics
  - name: Outbound Texting
    description: Campaign text and subscription-event feeds for BI ingestion
paths:
  /api/scheduler-analytics/summary:
    get:
      tags:
        - Scheduler Analytics (v0)
      summary: Get scheduler analytics summary
      description: >-
        Summary Simple Scheduler stats for today, this week, and this month.
        Requires the `read:scheduler_analytics` permission.
      operationId: getSchedulerAnalyticsSummary
      parameters:
        - $ref: '#/components/parameters/xTeamId'
        - $ref: '#/components/parameters/timezone'
      responses:
        '200':
          description: Summary stats
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      today:
                        $ref: '#/components/schemas/PeriodSummary'
                      thisWeek:
                        $ref: '#/components/schemas/PeriodSummary'
                      thisMonth:
                        $ref: '#/components/schemas/PeriodSummary'
                  metadata:
                    type: object
                    properties:
                      timezone:
                        type: string
                      generatedAt:
                        type: string
                        format: date-time
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    xTeamId:
      name: x-team-id
      in: header
      description: >-
        Target team ID. Required for multi-team (`enterprise_all_teams` /
        `portfolio_all_teams`) keys on v0 endpoints; single-team keys are locked
        to their team and omit it.
      schema:
        type: integer
    timezone:
      name: timezone
      in: query
      description: IANA timezone for date calculations (default America/New_York)
      schema:
        type: string
        default: America/New_York
  schemas:
    PeriodSummary:
      type: object
      properties:
        sessions:
          type: integer
          examples:
            - 312
        bookings:
          type: integer
          examples:
            - 89
        conversionRate:
          type: number
          examples:
            - 28.5
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Human-readable description (newer endpoints)
      required:
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key in the format `avoca_<64 hex characters>`

````