@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface GetPlanAuditLogsResponse

    Governance state and audit trail for one or more plans.

    interface GetPlanAuditLogsResponse {
        plans: {
            plan_id: string;
            plan_version: number;
            status: "active" | "suspended" | "completed";
            budget: {
                authorized?: number;
                committed?: number;
                remaining?: number;
                utilization_pct?: number;
            };
            channel_allocation?: {
                [k: string]: { committed?: number; pct?: number }
                | undefined;
            };
            summary: {
                checks_performed?: number;
                outcomes_reported?: number;
                statuses?: {
                    approved?: number;
                    denied?: number;
                    conditions?: number;
                    human_reviewed?: number;
                };
                findings_count?: number;
                escalations?: {
                    check_id: string;
                    reason: string;
                    resolution?: string;
                    resolved_at?: string;
                }[];
                drift_metrics?: {
                    escalation_rate?: number;
                    escalation_rate_trend?: "increasing"
                    | "stable"
                    | "declining";
                    auto_approval_rate?: number;
                    human_override_rate?: number;
                    mean_confidence?: number;
                    thresholds?: {
                        escalation_rate_max?: number;
                        escalation_rate_min?: number;
                        auto_approval_rate_max?: number;
                        human_override_rate_max?: number;
                    };
                };
            };
            entries?: {
                id: string;
                type: "outcome"
                | "check";
                timestamp: string;
                plan_id?: string;
                caller?: string;
                tool?: string;
                status?: "approved" | "denied" | "conditions";
                check_type?: "intent" | "execution";
                explanation?: string;
                policies_evaluated?: string[];
                categories_evaluated?: string[];
                findings?: {
                    category_id: string;
                    policy_id?: string;
                    severity: EscalationSeverity;
                    explanation: string;
                    confidence?: number;
                }[];
                outcome?: OutcomeType;
                committed_budget?: number;
                media_buy_id?: string;
                outcome_status?: string;
            }[];
            media_buys: {
                media_buy_id: string;
                status: "active"
                | "suspended"
                | "completed";
                committed: number;
                check_count?: number;
            }[];
        }[];
    }
    Index

    Properties

    Properties

    plans: {
        plan_id: string;
        plan_version: number;
        status: "active" | "suspended" | "completed";
        budget: {
            authorized?: number;
            committed?: number;
            remaining?: number;
            utilization_pct?: number;
        };
        channel_allocation?: {
            [k: string]: { committed?: number; pct?: number }
            | undefined;
        };
        summary: {
            checks_performed?: number;
            outcomes_reported?: number;
            statuses?: {
                approved?: number;
                denied?: number;
                conditions?: number;
                human_reviewed?: number;
            };
            findings_count?: number;
            escalations?: {
                check_id: string;
                reason: string;
                resolution?: string;
                resolved_at?: string;
            }[];
            drift_metrics?: {
                escalation_rate?: number;
                escalation_rate_trend?: "increasing"
                | "stable"
                | "declining";
                auto_approval_rate?: number;
                human_override_rate?: number;
                mean_confidence?: number;
                thresholds?: {
                    escalation_rate_max?: number;
                    escalation_rate_min?: number;
                    auto_approval_rate_max?: number;
                    human_override_rate_max?: number;
                };
            };
        };
        entries?: {
            id: string;
            type: "outcome"
            | "check";
            timestamp: string;
            plan_id?: string;
            caller?: string;
            tool?: string;
            status?: "approved" | "denied" | "conditions";
            check_type?: "intent" | "execution";
            explanation?: string;
            policies_evaluated?: string[];
            categories_evaluated?: string[];
            findings?: {
                category_id: string;
                policy_id?: string;
                severity: EscalationSeverity;
                explanation: string;
                confidence?: number;
            }[];
            outcome?: OutcomeType;
            committed_budget?: number;
            media_buy_id?: string;
            outcome_status?: string;
        }[];
        media_buys: {
            media_buy_id: string;
            status: "active"
            | "suspended"
            | "completed";
            committed: number;
            check_count?: number;
        }[];
    }[]

    Audit data for each requested plan.

    Type Declaration

    • plan_id: string

      Plan identifier.

    • plan_version: number

      Current plan version.

    • status: "active" | "suspended" | "completed"

      Plan lifecycle status.

    • budget: {
          authorized?: number;
          committed?: number;
          remaining?: number;
          utilization_pct?: number;
      }

      Budget state.

      • Optionalauthorized?: number

        Total authorized budget from the plan.

      • Optionalcommitted?: number

        Total budget committed from confirmed outcomes.

      • Optionalremaining?: number

        Authorized minus committed.

      • Optionalutilization_pct?: number

        Committed as a percentage of authorized.

    • Optionalchannel_allocation?: { [k: string]: { committed?: number; pct?: number } | undefined }

      Current channel mix. Keyed by channel ID.

    • summary: {
          checks_performed?: number;
          outcomes_reported?: number;
          statuses?: {
              approved?: number;
              denied?: number;
              conditions?: number;
              human_reviewed?: number;
          };
          findings_count?: number;
          escalations?: {
              check_id: string;
              reason: string;
              resolution?: string;
              resolved_at?: string;
          }[];
          drift_metrics?: {
              escalation_rate?: number;
              escalation_rate_trend?: "increasing"
              | "stable"
              | "declining";
              auto_approval_rate?: number;
              human_override_rate?: number;
              mean_confidence?: number;
              thresholds?: {
                  escalation_rate_max?: number;
                  escalation_rate_min?: number;
                  auto_approval_rate_max?: number;
                  human_override_rate_max?: number;
              };
          };
      }

      Aggregate validation and outcome statistics.

      • Optionalchecks_performed?: number

        Total governance checks performed.

      • Optionaloutcomes_reported?: number

        Total outcomes reported.

      • Optionalstatuses?: {
            approved?: number;
            denied?: number;
            conditions?: number;
            human_reviewed?: number;
        }

        Count of each governance check status.

        • Optionalapproved?: number
        • Optionaldenied?: number
        • Optionalconditions?: number
        • Optionalhuman_reviewed?: number

          Supplementary count of checks that went through internal human review. These checks are also counted in approved or denied.

      • Optionalfindings_count?: number

        Total findings across all checks and outcomes.

      • Optionalescalations?: { check_id: string; reason: string; resolution?: string; resolved_at?: string }[]

        All escalations and their resolutions.

      • Optionaldrift_metrics?: {
            escalation_rate?: number;
            escalation_rate_trend?: "increasing" | "stable" | "declining";
            auto_approval_rate?: number;
            human_override_rate?: number;
            mean_confidence?: number;
            thresholds?: {
                escalation_rate_max?: number;
                escalation_rate_min?: number;
                auto_approval_rate_max?: number;
                human_override_rate_max?: number;
            };
        }

        Aggregate governance metrics for detecting oversight drift. A declining escalation rate may indicate well-calibrated governance or eroding human oversight -- surfacing the trend lets the organization make that judgment.

        • Optionalescalation_rate?: number

          Fraction of checks that resulted in escalation.

        • Optionalescalation_rate_trend?: "increasing" | "stable" | "declining"

          Direction of escalation rate over the plan's lifetime.

        • Optionalauto_approval_rate?: number

          Fraction of checks approved without human intervention.

        • Optionalhuman_override_rate?: number

          Fraction of escalations where the human overrode the governance agent's recommendation.

        • Optionalmean_confidence?: number

          Average confidence score across all findings. Present when findings include confidence scores.

        • Optionalthresholds?: {
              escalation_rate_max?: number;
              escalation_rate_min?: number;
              auto_approval_rate_max?: number;
              human_override_rate_max?: number;
          }

          Organization-defined thresholds for drift metrics. When a metric crosses its threshold, the governance agent SHOULD include a finding on the next check. Set by the organization in governance agent configuration, echoed here for visibility.

          • Optionalescalation_rate_max?: number

            Maximum acceptable escalation rate. A rate above this suggests policy miscalibration.

          • Optionalescalation_rate_min?: number

            Minimum acceptable escalation rate. A rate below this may indicate eroding oversight.

          • Optionalauto_approval_rate_max?: number

            Maximum acceptable auto-approval rate.

          • Optionalhuman_override_rate_max?: number

            Maximum acceptable human override rate. A high rate suggests the governance agent's recommendations are poorly calibrated.

    • Optionalentries?: {
          id: string;
          type: "outcome" | "check";
          timestamp: string;
          plan_id?: string;
          caller?: string;
          tool?: string;
          status?: "approved" | "denied" | "conditions";
          check_type?: "intent" | "execution";
          explanation?: string;
          policies_evaluated?: string[];
          categories_evaluated?: string[];
          findings?: {
              category_id: string;
              policy_id?: string;
              severity: EscalationSeverity;
              explanation: string;
              confidence?: number;
          }[];
          outcome?: OutcomeType;
          committed_budget?: number;
          media_buy_id?: string;
          outcome_status?: string;
      }[]

      Ordered audit trail. Only present when include_entries is true.

    • media_buys: {
          media_buy_id: string;
          status: "active" | "suspended" | "completed";
          committed: number;
          check_count?: number;
      }[]

      Per-media-buy breakdown.