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

    Interface ReportingCapabilities

    Reporting capabilities available for a product

    interface ReportingCapabilities {
        available_reporting_frequencies: ReportingFrequency[];
        expected_delay_minutes: number;
        timezone: string;
        supports_webhooks: boolean;
        available_metrics: AvailableMetric[];
        supports_creative_breakdown?: boolean;
        supports_keyword_breakdown?: boolean;
        supports_geo_breakdown?: GeographicBreakdownSupport;
        supports_device_type_breakdown?: boolean;
        supports_device_platform_breakdown?: boolean;
        supports_audience_breakdown?: boolean;
        supports_placement_breakdown?: boolean;
        date_range_support: "date_range" | "lifetime_only";
        measurement_windows?: MeasurementWindow[];
    }
    Index

    Properties

    available_reporting_frequencies expected_delay_minutes timezone supports_webhooks available_metrics supports_creative_breakdown? supports_keyword_breakdown? supports_geo_breakdown? supports_device_type_breakdown? supports_device_platform_breakdown? supports_audience_breakdown? supports_placement_breakdown? date_range_support measurement_windows?

    Properties

    available_reporting_frequencies: ReportingFrequency[]

    Supported reporting frequency options

    expected_delay_minutes: number

    Expected delay in minutes before reporting data becomes available (e.g., 240 for 4-hour delay)

    0

    timezone: string

    Timezone for reporting periods. Use 'UTC' or IANA timezone (e.g., 'America/New_York'). Critical for daily/monthly frequency alignment.

    supports_webhooks: boolean

    Whether this product supports webhook-based reporting notifications

    available_metrics: AvailableMetric[]

    Metrics available in reporting. Impressions and spend are always implicitly included. When a creative format declares reported_metrics, buyers receive the intersection of these product-level metrics and the format's reported_metrics.

    supports_creative_breakdown?: boolean

    Whether this product supports creative-level metric breakdowns in delivery reporting (by_creative within by_package)

    supports_keyword_breakdown?: boolean

    Whether this product supports keyword-level metric breakdowns in delivery reporting (by_keyword within by_package)

    supports_geo_breakdown?: GeographicBreakdownSupport
    supports_device_type_breakdown?: boolean

    Whether this product supports device type breakdowns in delivery reporting (by_device_type within by_package)

    supports_device_platform_breakdown?: boolean

    Whether this product supports device platform breakdowns in delivery reporting (by_device_platform within by_package)

    supports_audience_breakdown?: boolean

    Whether this product supports audience segment breakdowns in delivery reporting (by_audience within by_package)

    supports_placement_breakdown?: boolean

    Whether this product supports placement breakdowns in delivery reporting (by_placement within by_package)

    date_range_support: "date_range" | "lifetime_only"

    Whether delivery data can be filtered to arbitrary date ranges. 'date_range' means the platform supports start_date/end_date parameters. 'lifetime_only' means the platform returns campaign lifetime totals and date range parameters are not accepted.

    measurement_windows?: MeasurementWindow[]

    Measurement maturation stages available for this product. Used by any channel where billing-grade data is produced in phases rather than arriving final on day one. Examples: broadcast/linear TV (Live → C3 → C7 DVR accumulation), DOOH (tentative plays → post-IVT/fraud-check final), digital with IVT filtering (raw → GIVT filtered → SIVT filtered), podcast (7-day downloads → 30-day downloads). Each window defines an accumulation period and expected data availability. When present, delivery reports reference a specific window_id. Sellers whose data is final on first delivery typically omit this.

    Settings

    Member Visibility

    On This Page

    Properties