BoringToolsKit Usage events API

openapi: 3.2.0
info:
  title: BoringToolsKit Usage events API
  version: 1.0.0
  description: Privacy-preserving public endpoints for BoringToolsKit (boringtoolskit.com). Every calculator runs in the browser; only optional, labeled event and region endpoints exist server-side. All endpoints require no authentication and collect no personal data. See https://boringtoolskit.com/llms.txt for the full tool catalogue and https://boringtoolskit.com/tool-knowledge.json for evidence-labeled tool records.
  contact:
    name: BoringToolsKit
    url: https://boringtoolskit.com/contact/
servers:
- url: https://boringtoolskit.com
tags:
- name: Usage events
  description: Optional, labeled, privacy-bounded usage events.
paths:
  /api/events:
    post:
      tags:
      - Usage events
      operationId: postUsageEvent
      summary: Record an optional, labeled, privacy-bounded usage event
      description: Accepts a validated usage event (tool_open, result_copied, ai_referral_*, etc.) with an allow-listed path. Inputs are never transmitted; only the event name, allow-listed path, source, and cohort are recorded, and synthetic verification traffic is excluded from business aggregates. Bots and crawlers receive a 204 with an ignored receipt.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - v
              - event
              - path
              - source
              - cohort
              properties:
                v:
                  type: integer
                  const: 1
                  description: Schema version.
                event:
                  type: string
                  description: One of the allow-listed event names (tool_open, result_valid, result_invalid, result_copied, result_downloaded, result_reset, result_complete, result_feedback_useful, result_feedback_not_useful, related_tool_open, scenario_save, guide_tool_open, comparison_mode_open, offer_click, ai_referral_*).
                path:
                  type: string
                  pattern: ^/|^/[a-z0-9][a-z0-9-/]{0,119}/$
                  description: Allow-listed page path.
                source:
                  type: string
                  enum:
                  - tool
                  - guide
                  - home
                  - related
                  - scenario
                cohort:
                  type: string
                  enum:
                  - new
                  - returning
                  - unknown
      responses:
        '204':
          description: Event accepted (or silently ignored for bots/crawlers).
        '400':
          description: Invalid Content-Type or payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Disallowed Origin or fetch-site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method not allowed (only POST is supported).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Storage unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine-readable error code.
        message:
          type: string
          description: Human-readable error description.
        resolution:
          type: string
          description: Optional hint for how to resolve the error.