@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Type Alias GetPlanAuditLogsRequest

    GetPlanAuditLogsRequest: { [k: string]: unknown } & {
        adcp_major_version?: number;
        plan_ids?: string[];
        portfolio_plan_ids?: string[];
        governance_contexts?: string[];
        purchase_types?: PurchaseType[];
        include_entries?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }

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

    Type Declaration

    • [k: string]: unknown
    • Optionaladcp_major_version?: number

      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.

      1

      99

    • Optionalplan_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.

    • Optionalportfolio_plan_ids?: string[]

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

    • Optionalgovernance_contexts?: string[]

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

    • Optionalpurchase_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).

    • Optionalinclude_entries?: boolean

      Include the full audit trail. Default: false.

    • Optionalcontext?: ContextObject
    • Optionalext?: ExtensionObject

    Settings

    Member Visibility