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

# Reports Summary

> An owner's business-health snapshot in one call: active tutors/students,
sessions today, money settled this week vs outstanding, and the number of
approvals waiting. Day/week boundaries are UTC; the week starts Monday.

No new rollup table — every figure is summed server-side in one call
(`get_org_summary_metrics`).



## OpenAPI

````yaml /openapi.json get /v1/reports/summary
openapi: 3.1.0
info:
  title: EquateIt Public API
  description: >-
    REST API for EquateIt tutoring organisations. Pipe your sessions, invoices,
    payments, tutor earnings, students, and more into your own tools. Most
    endpoints are reads; a focused set of writes (each gated by a *:write scope)
    create or update data, including creating student/tutor/parent accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=ei_live_...

    Mint keys in the EquateIt app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/reports/summary:
    get:
      tags:
        - Reports
      summary: Reports Summary
      description: >-
        An owner's business-health snapshot in one call: active tutors/students,

        sessions today, money settled this week vs outstanding, and the number
        of

        approvals waiting. Day/week boundaries are UTC; the week starts Monday.


        No new rollup table — every figure is summed server-side in one call

        (`get_org_summary_metrics`).
      operationId: reports_summary_v1_reports_summary_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Summary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Summary:
      properties:
        active_tutors:
          type: integer
          title: Active Tutors
          default: 0
        active_students:
          type: integer
          title: Active Students
          default: 0
        sessions_today:
          type: integer
          title: Sessions Today
          default: 0
        settled_this_week_cents:
          type: integer
          title: Settled This Week Cents
          default: 0
        outstanding_cents:
          type: integer
          title: Outstanding Cents
          default: 0
        pending_approvals:
          $ref: '#/components/schemas/PendingApprovals'
      type: object
      required:
        - pending_approvals
      title: Summary
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PendingApprovals:
      properties:
        mileage:
          type: integer
          title: Mileage
          default: 0
        expenses:
          type: integer
          title: Expenses
          default: 0
        total:
          type: integer
          title: Total
          default: 0
      type: object
      title: PendingApprovals
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````