@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface GetPlanAuditLogsRequest

    Retrieve governance state and audit trail for one or more plans.

    interface GetPlanAuditLogsRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        plan_ids?: string[];
        portfolio_plan_ids?: string[];
        governance_contexts?: string[];
        purchase_types?: PurchaseType[];
        include_entries?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version? adcp_major_version? plan_ids? portfolio_plan_ids? governance_contexts? purchase_types? include_entries? context? ext?

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    plan_ids?: string[]

    Plan IDs to retrieve. For a single plan, pass a one-element array. Plans uniquely scope account and operator; do not include a separate account field — the governance agent resolves account from each plan. Including account is rejected by additionalProperties: false.

    portfolio_plan_ids?: string[]

    Portfolio plan IDs. The governance agent expands each to its member_plan_ids and returns combined audit data.

    governance_contexts?: string[]

    Filter audit entries by governance context. Returns only checks and outcomes that share these governance contexts, enabling lifecycle tracing across purchase types.

    purchase_types?: PurchaseType[]

    Filter audit entries by purchase type. Returns only checks and outcomes matching these purchase types (e.g., ['rights_license'] to see all rights activity).

    include_entries?: boolean

    Include the full audit trail. Default: false.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties