TrackMCP API

openapi: 3.1.0
info:
  title: TrackMCP API
  version: '2026-10-19'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-19: 22 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; TrackMCP has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 21
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-19'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://trackmcp.com/docs/api
paths:
  /api/v1/alert-destinations:
    post:
      operationId: post_api_v1_alert_destinations
      tags:
      - Api
      summary: Create a generic HTTPS webhook destination using an external secret reference
      description: POST /api/v1/alert-destinations creates a webhook destination.
      x-source: https://trackmcp.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AlertDestinationsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/alert-incidents:
    get:
      operationId: get_api_v1_alert_incidents
      tags:
      - Api
      summary: List bounded regression incidents and their data status
      description: GET /api/v1/alert-incidents lists regression incidents.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of incidents to return (default 50)
      - name: workspace_id
        in: query
        required: false
        schema:
          type: string
        description: Optional workspace identifier for browser requests
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/alert-incidents/{id}/deliveries:
    get:
      operationId: get_api_v1_alert_incidents_id_deliveries
      tags:
      - Api
      summary: Inspect bounded webhook delivery attempts without secrets
      description: GET /api/v1/alert-incidents/{id}/deliveries returns delivery attempt details.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: workspace_id
        in: query
        required: false
        schema:
          type: string
        description: Optional workspace identifier for browser requests
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/alerts:
    get:
      operationId: get_api_v1_alerts
      tags:
      - Api
      summary: List authenticated workspace alert configurations
      description: GET /api/v1/alerts returns a list of alert configurations for the workspace.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of alerts to return (default 50)
      - name: workspace_id
        in: query
        required: false
        schema:
          type: string
        description: Optional workspace identifier for browser requests
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/analytics:
    get:
      operationId: get_api_v1_analytics
      tags:
      - Api
      summary: Workspace metrics, tools, clients, sessions, and insights
      description: GET /api/v1/analytics returns aggregated analytics for the workspace.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: Number of days to query (1‑90, default 30)
      - name: workspace_id
        in: query
        required: false
        schema:
          type: string
        description: Optional workspace identifier for browser requests
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1AnalyticsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_analytics
      tags:
      - Api
      summary: POST /api/v1/analytics
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AnalyticsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://trackmcp.com/api/v1/analytics?days=7"  -H "Authorization: Bearer $TRACKMCP_KEY" Send telemetry SDKs send canonical
          batches to the ingest endpoint automatically. You normally do not call it directly, but the wire format is useful when integrating another
          runtime. curl https://trackmcp.com/api/v1/ingest  -H "Authorization: Bearer $TRACKMCP_KEY"  -H "Content-Type: application/json"  -d '
  /api/v1/ingest:
    post:
      operationId: post_api_v1_ingest
      tags:
      - Api
      summary: Submit a validated telemetry batch
      description: POST /api/v1/ingest is the canonical write plane. It validates event IDs, timestamps, types, numeric fields, and batch/request
        limits; duplicate event IDs are idempotently ignored.
      x-source: https://trackmcp.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1IngestRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/otel/v1/traces:
    post:
      operationId: post_api_v1_otel_v1_traces
      tags:
      - Api
      summary: Accept bounded OTLP/HTTP JSON MCP span metadata; protobuf and gRPC are unsupported
      description: If you already emit OpenTelemetry spans, TrackMCP accepts a narrow OTLP/HTTP JSON adapter at this endpoint.
      x-source: https://trackmcp.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1OtelV1TracesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1OtelV1TracesResponse'
      x-evidence:
        kind: documentation
  /api/v1/tool-quality:
    get:
      operationId: get_api_v1_tool_quality
      tags:
      - Api
      summary: Bounded tool-quality metrics, catalog history, workflow associations, and insufficient-data states
      description: GET /api/v1/tool-quality provides tool quality metrics for the authenticated workspace.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: Number of days to query (1‑90, default 30)
      - name: workspace_id
        in: query
        required: false
        schema:
          type: string
        description: Optional workspace identifier for browser requests
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ToolQualityResponse'
      x-evidence:
        kind: documentation
  /api/v1/traces:
    get:
      operationId: get_api_v1_traces
      tags:
      - Api
      summary: Inspect ordered events for one protocol session or bounded correlation handle
      description: GET /api/v1/traces returns events for a given session or correlation handle.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: session_id
        in: query
        required: false
        schema:
          type: string
        description: Session identifier (required if correlation_handle not provided)
      - name: correlation_handle
        in: query
        required: false
        schema:
          type: string
        description: Correlation handle identifier
      - name: workspace_id
        in: query
        required: false
        schema:
          type: string
        description: Optional workspace identifier for browser requests
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Number of events to return (default 200, max 1000)
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1TracesResponse'
      x-evidence:
        kind: documentation
  /api/v2/action-queue:
    get:
      operationId: get_api_v2_action_queue
      tags:
      - Api
      summary: Workspace‑scoped action items; lifecycle mutations remain protected
      description: Retrieves action‑queue items for the workspace.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by queue status (e.g., open).
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/catalogs:
    get:
      operationId: get_api_v2_catalogs
      tags:
      - Api
      summary: Current bounded catalog snapshot projection
      description: Returns a JSON snapshot of the current catalog.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/data-trust:
    get:
      operationId: get_api_v2_data_trust
      tags:
      - Api
      summary: Query window, freshness, counts, and truncation provenance
      description: Provides data‑trust metadata for the response.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/journeys:
    get:
      operationId: get_api_v2_journeys
      tags:
      - Api
      summary: Bounded correlated sessions, not unique people
      description: Lists correlated session journeys.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/outcomes:
    get:
      operationId: get_api_v2_outcomes
      tags:
      - Api
      summary: Evidence‑backed outcomes with unknown states preserved
      description: Returns outcome data for the specified time range.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/overview:
    get:
      operationId: get_api_v2_overview
      tags:
      - Api
      summary: Versioned Founder OS overview with data-trust metadata
      description: GET /api/v2/overview provides an overview of the Founder OS data.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: Number of days to query (default 30)
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/people:
    get:
      operationId: get_api_v2_people
      tags:
      - Api
      summary: Resolver coverage and client observations; no unique‑user claims
      description: Returns aggregated people‑related observations.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/prompts:
    get:
      operationId: get_api_v2_prompts
      tags:
      - Api
      summary: Observed prompt protocol methods; arguments are not exposed
      description: Provides data about observed prompt usage.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/reliability:
    get:
      operationId: get_api_v2_reliability
      tags:
      - Api
      summary: Conservative observed reliability evidence, not uptime
      description: Provides reliability evidence for the workspace.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/resources:
    get:
      operationId: get_api_v2_resources
      tags:
      - Api
      summary: Observed resource protocol methods; entities are not inferred
      description: Lists observed resource protocol methods.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        description: Query window size (1‑90 days, defaults to 30).
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Optional paging limit (1‑100).
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/tools:
    get:
      operationId: get_api_v2_tools
      tags:
      - Api
      summary: Bounded tool performance and catalog projection with optional cursor pagination
      description: GET /api/v2/tools returns tool performance data.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: Number of days to query (default 30)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Page size (1‑100)
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: Opaque pagination cursor
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v2/tools/{name}:
    get:
      operationId: get_api_v2_tools_name
      tags:
      - Api
      summary: One tool's observed calls, errors, and latency
      description: GET /api/v2/tools/{name} provides detailed metrics for a specific tool.
      x-source: https://trackmcp.com/docs/api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: Number of days to query (default 30)
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV1AlertDestinationsRequest:
      type: object
      properties:
        url:
          type: string
          description: Destination HTTPS URL
        secret_ref:
          type: string
          description: Reference to external secret for signing
      required:
      - url
      - secret_ref
    GetApiV1AnalyticsResponse:
      type: object
      properties:
        range_days:
          type: integer
        tool_calls:
          type: integer
        sessions:
          type: integer
        errors:
          type: integer
        completion_rate:
          type: number
        intent_sources:
          type: object
        missing_capabilities:
          type: array
        tools:
          type: array
        insights:
          type: array
    PostApiV1AnalyticsRequest:
      type: object
      properties:
        events:
          type: array
          items:
            type: object
            properties:
              schema_version:
                type: string
              event_id:
                type: string
              event_type:
                type: string
              observation_source:
                type: string
              service:
                type: string
              environment:
                type: string
              tool_name:
                type: string
              started_at:
                type: string
                format: date-time
              duration_ms:
                type: integer
              success:
                type: boolean
              is_error:
                type: boolean
              payload_policy:
                type: string
              payload:
                type: object
                properties:
                  args:
                    type: object
    PostApiV1IngestRequest:
      type: object
      properties:
        events:
          type: array
          description: Array of event objects
        schema_version:
          type: string
          description: Version of the event schema
        event_id:
          type: string
          description: Unique identifier for the event
        event_type:
          type: string
          description: Type of the event (e.g., tool_call)
        observation_source:
          type: string
          description: Source of observation (server or client)
        service:
          type: string
          description: Name of the MCP service
        environment:
          type: string
          description: Deployment environment
        tool_name:
          type: string
          description: Name of the tool invoked
        started_at:
          type: string
          description: ISO‑8601 timestamp when the event started
        duration_ms:
          type: integer
          description: Duration of the event in milliseconds
        success:
          type: boolean
          description: Whether the event succeeded
        is_error:
          type: boolean
          description: Whether the event resulted in an error
        payload_policy:
          type: string
          description: Policy for payload redaction
        payload:
          type: object
          description: Event payload (example shows empty args object)
      required:
      - events
      - schema_version
      - event_id
      - event_type
      - observation_source
      - service
      - environment
      - tool_name
      - started_at
      - duration_ms
      - success
      - is_error
      - payload_policy
      - payload
    PostApiV1OtelV1TracesRequest:
      type: object
      properties:
        resourceSpans:
          type: array
          description: Array of resource span objects
        resource:
          type: object
          description: Resource attributes (e.g., service.name, deployment.environment.name)
        scopeSpans:
          type: array
          description: Array of scope span objects containing spans
        spans:
          type: array
          description: Array of span objects
        name:
          type: string
          description: Span name (e.g., tools/call)
        startTimeUnixNano:
          type: string
          description: Start time in Unix nanoseconds
        endTimeUnixNano:
          type: string
          description: End time in Unix nanoseconds
        attributes:
          type: array
          description: Span attributes such as mcp.method.name, gen_ai.tool.name, mcp.transport
      required:
      - resourceSpans
      - resource
      - scopeSpans
      - spans
      - name
      - startTimeUnixNano
      - endTimeUnixNano
      - attributes
    PostApiV1OtelV1TracesResponse:
      type: object
      properties:
        accepted:
          type: integer
          description: Number of spans accepted
        rejected:
          type: integer
          description: Number of spans rejected
    GetApiV1ToolQualityResponse:
      type: object
      properties:
        range_days:
          type: integer
        source_event_count:
          type: integer
        truncated:
          type: boolean
        tools:
          type: array
    GetApiV1TracesResponse:
      type: object
      properties:
        session_id:
          type: string
        correlation_handle:
          type: string
        event_count:
          type: integer
        events:
          type: array
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api