decide-fyi Effectiveness API

openapi: 3.2.0
info:
  title: Decide Decision Effectiveness API
  summary: Decision protocol for state-changing software actions.
  description: Call Decide before products, agents, queues, billing systems, CRMs, or internal tools change state. The API returns a signed Decision Record v1 object with policy bundle attestation, evidence, action binding, replay, verification handles, portable Decision Packet v1 exports, simulation-only counterfactual analysis, cryptographic audit chains, Action Execution Receipts, Outcome Records, CRM Sync Records, predictive confidence, first-party policy pattern templates, policy effectiveness metrics, opt-in anonymized benchmarks, and explainable anomaly reports derived from reported outcomes.
  version: 1.13.0
  x-decision-protocol-version: decision_protocol_v1
  x-decision-record-version: decision_record_v1
  x-decision-packet-version: decision_packet_v1
servers:
- url: https://www.decide.fyi
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Effectiveness
  description: Outcome-based policy effectiveness scoring scoped to the caller API key.
paths:
  /api/decision/policies/{policy_id}/effectiveness:
    get:
      tags:
      - Effectiveness
      operationId: getPolicyEffectiveness
      summary: Read outcome-based policy effectiveness
      description: Returns policy_effectiveness_v1 metrics derived from the latest Decision Outcome per decision within the caller API-key scope. Proxy false-positive/false-negative rates are outcome proxies, not causal ML claims.
      parameters:
      - name: policy_id
        in: path
        required: true
        schema:
          type: string
          maxLength: 180
      - name: policy_version
        in: query
        required: false
        schema:
          type: string
          maxLength: 180
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100000
          default: 500
      - name: min_sample
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100000
          default: 10
      responses:
        '200':
          description: Policy effectiveness metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyEffectiveness'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PolicyEffectiveness:
      type: object
      required:
      - ok
      - policy_effectiveness_version
      - policy_id
      - decisions_analyzed
      - metrics
      - effectiveness_hash
      - recommendation
      properties:
        ok:
          type: boolean
        policy_effectiveness_version:
          type: string
          const: policy_effectiveness_v1
        generated_at:
          type: string
        policy_id:
          type: string
        policy_version:
          type:
          - string
          - 'null'
        source:
          type: string
          const: decision_outcomes
        minimum_sample_size:
          type: integer
        decisions_analyzed:
          type: integer
        outcomes_analyzed:
          type: integer
        distinct_decisions:
          type: integer
        by_status:
          type: object
          additionalProperties:
            type: integer
        by_verdict:
          type: object
          additionalProperties:
            type: integer
        metrics:
          type: object
          properties:
            success_rate:
              type:
              - number
              - 'null'
            failure_rate:
              type:
              - number
              - 'null'
            revert_rate:
              type:
              - number
              - 'null'
            review_rate:
              type:
              - number
              - 'null'
            skipped_rate:
              type:
              - number
              - 'null'
            unknown_rate:
              type:
              - number
              - 'null'
            terminal_coverage:
              type:
              - number
              - 'null'
            executed_rate:
              type:
              - number
              - 'null'
          additionalProperties: true
        proxy_quality:
          type: object
          properties:
            estimated_false_positive_rate:
              type:
              - number
              - 'null'
            estimated_false_negative_rate:
              type:
              - number
              - 'null'
            note:
              type: string
          additionalProperties: true
        effectiveness_score:
          type:
          - number
          - 'null'
        confidence:
          type:
          - number
          - 'null'
        status:
          type: string
          enum:
          - scored
          - insufficient_data
        recommendation:
          type: string
          enum:
          - insufficient_data
          - review_policy
          - monitor
          - healthy
        window:
          type: object
          additionalProperties: true
        data_quality:
          type: object
          additionalProperties: true
        effectiveness_hash:
          type: string
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        c:
          type: string
        v:
          type: string
        request_id:
          type: string
        error:
          type: string
        message:
          type: string
      additionalProperties: true
  responses:
    Unauthorized:
      description: API key missing, invalid, inactive, or unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key