FUSE Health Dashboard & Analytics API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) Dashboard & Analytics API
  version: 1.0.0
  description: 'Server-to-server API exposing the FUSE brand-admin surface so a single brand/tenant can build its own admin frontend. Every request is authenticated with an API key bound to exactly one clinic; all data is auto-scoped to that clinic and cannot reach another brand''s data. Isolation is enforced by application-layer clinic filtering on every query.


    COVERAGE: 218 operations across 180 paths, and EVERY ONE is available to every brand. There is no per-clinic enablement step. What governs access: your API key and its scopes, the clinic the key belongs to (every read and write is filtered to it), your plan''s entitlements for the two commercially-gated areas — Affiliates (`AFFILIATES_TIER_REQUIRED`) and CRM Connect (`CRM_TIER_REQUIRED`) — and rate limits.


    AUTH: the external /api/v1 surface uses an API key (`x-api-key`, ApiKeyAuth). Key management (/api-keys) and /auth/signin live at the API root and use a brand-admin JWT (BearerAuth); /auth/signin itself is unauthenticated.


    SCOPES: every key carries scopes; read-only is the default and mutating endpoints require the `write` scope (403 INSUFFICIENT_SCOPE otherwise). Keys default to a 1-year expiry.


    RATE LIMITING: every endpoint may additionally return `429 Too Many Requests` with a `Retry-After` header; 429 is not repeated on each operation below.


    PLATFORM FIELDS: product cost, fees, pharmacy routing, doctor questions and FUSE approvals are set by FUSE, not by the brand. Any write (POST/PUT/PATCH/DELETE) whose JSON body carries one of those fields at any depth — for example `pharmacyPrice`, `shippingFeeUsd`, `coolerFeeUsd`, `pharmacyId`, `preferredPharmacyId`, `pharmacyProvider`, `requiredDoctorQuestions`, `facilitationFee`, `placeholderPrice`, `legalBusinessName`, `isTemplate` or `tenantManagerApproved` — is refused with `403 PLATFORM_FIELD`, whose `fields` array lists the offending paths; remove them and resend. (One exception: `POST /api/v1/products` still accepts the `pharmacyPrice` its schema requires, and ignores it.) 403 PLATFORM_FIELD is not repeated on each operation below.'
servers:
- url: https://api-dev.fusehealth.com
  description: Development
- url: https://api.fusehealth.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Dashboard & Analytics
  description: Clinic-level aggregates only (recent-activity is HIPAA-scrubbed). Reads take clinicId from the key, never the query.
paths:
  /api/v1/dashboard/overview:
    get:
      tags:
      - Dashboard & Analytics
      summary: Top-line dashboard summary
      operationId: getApiV1DashboardOverview
      description: Top-line dashboard summary.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/dashboard/metrics:
    get:
      tags:
      - Dashboard & Analytics
      summary: Key metric tiles (orders, revenue, patients)
      operationId: getApiV1DashboardMetrics
      description: Key metric tiles (orders, revenue, patients).
      security:
      - ApiKeyAuth: []
      parameters:
      - name: startDate
        in: query
        required: false
        schema:
          type: string
        example: '2026-01-01'
      - name: endDate
        in: query
        required: false
        schema:
          type: string
        example: '2026-12-31'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/dashboard/earnings-report:
    get:
      tags:
      - Dashboard & Analytics
      summary: Earnings breakdown report
      operationId: getApiV1DashboardEarningsreport
      description: Earnings breakdown report.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/dashboard/recent-activity:
    get:
      tags:
      - Dashboard & Analytics
      summary: Recent clinic activity feed (PHI-scrubbed)
      operationId: getApiV1DashboardRecentactivity
      description: Recent clinic activity feed (PHI-scrubbed).
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/dashboard/revenue-chart:
    get:
      tags:
      - Dashboard & Analytics
      summary: Time-series revenue chart data
      operationId: getApiV1DashboardRevenuechart
      description: Time-series revenue chart data.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
        example: 30d
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/dashboard/projected-revenue:
    get:
      tags:
      - Dashboard & Analytics
      summary: Projected revenue from active subscriptions
      operationId: getApiV1DashboardProjectedrevenue
      description: Projected revenue from active subscriptions.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/analytics/forms:
    get:
      tags:
      - Dashboard & Analytics
      summary: The clinic's own intake-form metrics (no PHI)
      operationId: getApiV1AnalyticsForms
      description: The clinic's own intake-form metrics (no PHI).
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/likes/admin/analytics/{tenantProductId}:
    get:
      tags:
      - Dashboard & Analytics
      summary: Like/engagement analytics for one of the clinic's tenant products
      operationId: getApiV1LikesAdminAnalyticsByTenantProductId
      description: Like/engagement analytics for one of the clinic's tenant products.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: tenantProductId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/likes/admin/counts:
    post:
      tags:
      - Dashboard & Analytics
      summary: Bulk like counts for a list of tenant products (POST only because ids travel in…
      operationId: postApiV1LikesAdminCounts
      description: Bulk like counts for a list of tenant products (POST only because ids travel in the body; mutates nothing).
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tenantProductIds:
                  type: array
                  items:
                    type: string
            example:
              tenantProductIds:
              - <tenant-product-uuid>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/analytics/forms/{formId}/sessions:
    get:
      tags:
      - Dashboard & Analytics
      summary: Per-form intake funnel sessions
      operationId: getApiV1AnalyticsFormsByFormIdSessions
      description: Session-level intake funnel breakdown for one of this clinic's forms. ⚠️ PHI-bearing — the sessions array includes visitor/patient name, email and phone. Read-only (read scope); every call is audit-logged.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: formId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/analytics/programs/{questionnaireId}/sessions:
    get:
      tags:
      - Dashboard & Analytics
      summary: Per-program intake funnel sessions
      operationId: getApiV1AnalyticsProgramsByQuestionnaireIdSessions
      description: Session-level intake funnel breakdown keyed by the program's teleform (questionnaire) id, scoped to this clinic's own programs. ⚠️ PHI-bearing — the sessions array includes visitor/patient name, email and phone. Read-only (read scope); every call is audit-logged.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: questionnaireId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Forbidden:
      description: Authenticated but not permitted (insufficient scope, wrong role, or FUSE feature not enabled)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, invalid, inactive, or expired API key (or JWT)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found (or not owned by the key's clinic)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      description: 'Failure shape. NOTE: most modules use `message`; programs endpoints use `error`. Read both. Some errors include a machine-readable `code` and/or a `data` payload.'
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        message:
          type: string
        error:
          type: string
        code:
          type: string
        data: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Clinic-scoped API key. Keep server-side; never expose in a browser or app bundle.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: FUSE brand-admin JWT (from POST /auth/signin). Used ONLY by the key-management endpoints — the external /api/v1 surface never accepts JWTs, and API keys never work on key management.