ClassQuill Reports API

openapi: 3.2.0
info:
  title: ClassQuill Public Reports API
  description: 'REST API for ClassQuill 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=cq_live_...


    Mint keys in the ClassQuill app under Settings → Developers.'
  version: 1.0.0
security:
- ApiKeyAuth: []
tags:
- 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 — `error.details.errors` lists the fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing, malformed, revoked, or expired credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The credential lacks the scope this endpoint requires.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limit exceeded — honour Retry-After and the RateLimit-* headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiErrorBody:
      description: The `error` object every /v1 error response carries.
      properties:
        code:
          description: 'Stable machine-readable error code: bad_request, unauthorized, forbidden, not_found, conflict, validation_error, rate_limited, or internal_error.'
          examples:
          - not_found
          title: Code
          type: string
        message:
          description: Human-readable explanation, safe to surface to end users.
          examples:
          - Session not found
          title: Message
          type: string
        status:
          description: The HTTP status code, repeated in the body.
          examples:
          - 404
          title: Status
          type: integer
        details:
          additionalProperties: true
          description: Error-specific context. 422 carries the field errors under `errors`; 429 carries `retry_after_seconds`.
          title: Details
          type: object
      required:
      - code
      - message
      - status
      title: ApiErrorBody
      type: object
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
      - error
      title: ApiError
      type: object
    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
    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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=cq_live_...`