@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface GetReportingStatusRequest

    Authoritative caller/account-isolated reporting reliability read. The authenticated caller identity comes only from transport authentication, never request fields. summary answers the operational question for independently selected delivery configurations/feeds; periods returns a cursor-paginated obligation ledger; revision resolves one exact retained revision and its materializations/resources. Unknown, unauthorized, cross-caller, and cross-account identifiers MUST be indistinguishable. Sellers implementing this task MUST advertise media_buy.reporting_delivery in experimental_features.

    interface GetReportingStatusRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        account: CanonicalAccountReference;
        view: ReportingStatusView;
        media_buy_ids?: string[];
        delivery_config_ids?: string[];
        feed_purposes?: ReportingFeedPurpose[];
        period?: { start: string; end: string };
        health?: ReportingHealth[];
        finality?: ReportingFinality[];
        reporting_revision_id?: string;
        changes_after?: string;
        pagination?: PaginationRequest;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index
    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.

    account: CanonicalAccountReference
    view: ReportingStatusView
    media_buy_ids?: string[]

    Optional summary/periods scope. Omit for every accessible media buy in the account.

    100

    delivery_config_ids?: string[]

    Optional summary/periods scope. Use to reconcile billing, analytics, and pacing independently. Omit for every active caller-owned configuration.

    16

    feed_purposes?: ReportingFeedPurpose[]

    Optional summary/periods feed filter. The response echoes exact resolved configuration generations so this never creates an opaque aggregate.

    period?: { start: string; end: string }

    Half-open summary/periods horizon. Omit for the seller's documented operational default horizon; the response always echoes the evaluated scope.

    Type Declaration

    • start: string

      date-time

    • end: string

      date-time

    health?: ReportingHealth[]

    Periods-view result filter only; it never changes summary health.

    finality?: ReportingFinality[]
    reporting_revision_id?: string

    Exact retained revision to resolve in revision view.

    1

    255

    ^[A-Za-z0-9_.:-]{1,255}$

    changes_after?: string

    Periods-view incremental-repair checkpoint previously returned as changes_checkpoint after fully consuming a response. Returns newly committed obligations, revisions, adjustments, materializations, consumer status statements, revision receipts, and adjustment receipts plus the current projection of each affected obligation. Omit for a full ledger read.

    1

    2048

    pagination?: PaginationRequest
    context?: ContextObject