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

    Interface GetMediaBuyDeliveryRequest

    Request parameters for retrieving comprehensive delivery metrics

    interface GetMediaBuyDeliveryRequest {
        account?: AccountReference;
        media_buy_ids?: string[];
        status_filter?: MediaBuyStatus | MediaBuyStatus[];
        start_date?: string;
        end_date?: string;
        include_package_daily_breakdown?: boolean;
        attribution_window?: {
            post_click?: Duration;
            post_view?: Duration;
            model?: AttributionModel;
        };
        reporting_dimensions?: {
            geo?: {
                geo_level: GeographicTargetingLevel;
                system?: MetroAreaSystem
                | PostalCodeSystem;
                limit?: number;
                sort_by?: SortMetric;
            };
            device_type?: { limit?: number; sort_by?: SortMetric };
            device_platform?: { limit?: number; sort_by?: SortMetric };
            audience?: { limit?: number; sort_by?: SortMetric };
            placement?: { limit?: number; sort_by?: SortMetric };
        };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    account? media_buy_ids? status_filter? start_date? end_date? include_package_daily_breakdown? attribution_window? reporting_dimensions? context? ext?

    Properties

    account?: AccountReference
    media_buy_ids?: string[]

    Array of media buy IDs to get delivery data for

    status_filter?: MediaBuyStatus | MediaBuyStatus[]

    Filter by status. Can be a single status or array of statuses

    start_date?: string

    Start date for reporting period (YYYY-MM-DD). When omitted along with end_date, returns campaign lifetime data. Only accepted when the product's reporting_capabilities.date_range_support is 'date_range'.

    end_date?: string

    End date for reporting period (YYYY-MM-DD). When omitted along with start_date, returns campaign lifetime data. Only accepted when the product's reporting_capabilities.date_range_support is 'date_range'.

    include_package_daily_breakdown?: boolean

    When true, include daily_breakdown arrays within each package in by_package. Useful for per-package pacing analysis and line-item monitoring. Omit or set false to reduce response size — package daily data can be large for multi-package buys over long flights.

    attribution_window?: {
        post_click?: Duration;
        post_view?: Duration;
        model?: AttributionModel;
    }

    Attribution window to apply for conversion metrics. When provided, the seller returns conversion data using the requested lookback windows instead of their platform default. The seller echoes the applied window in the response. Sellers that do not support configurable windows ignore this field and return their default. Check get_adcp_capabilities conversion_tracking.attribution_windows for available options.

    Type Declaration

    • Optionalpost_click?: Duration

      Post-click attribution window to apply.

    • Optionalpost_view?: Duration

      Post-view attribution window to apply.

    • Optionalmodel?: AttributionModel
    reporting_dimensions?: {
        geo?: {
            geo_level: GeographicTargetingLevel;
            system?: MetroAreaSystem | PostalCodeSystem;
            limit?: number;
            sort_by?: SortMetric;
        };
        device_type?: { limit?: number; sort_by?: SortMetric };
        device_platform?: { limit?: number; sort_by?: SortMetric };
        audience?: { limit?: number; sort_by?: SortMetric };
        placement?: { limit?: number; sort_by?: SortMetric };
    }

    Request dimensional breakdowns in delivery reporting. Each key enables a specific breakdown dimension within by_package — include as an empty object (e.g., "device_type": {}) to activate with defaults. Omit entirely for no breakdowns (backward compatible). Unsupported dimensions are silently omitted from the response. Note: keyword, catalog_item, and creative breakdowns are returned automatically when the seller supports them and are not controlled by this object.

    Type Declaration

    • Optionalgeo?: {
          geo_level: GeographicTargetingLevel;
          system?: MetroAreaSystem | PostalCodeSystem;
          limit?: number;
          sort_by?: SortMetric;
      }

      Request geographic breakdown. Check reporting_capabilities.supports_geo_breakdown for available levels and systems.

      • geo_level: GeographicTargetingLevel
      • Optionalsystem?: MetroAreaSystem | PostalCodeSystem

        Classification system for metro or postal_area levels (e.g., 'nielsen_dma', 'us_zip'). Required when geo_level is 'metro' or 'postal_area'.

      • Optionallimit?: number

        Maximum number of geo entries to return. Defaults to 25. When truncated, by_geo_truncated is true in the response.

      • Optionalsort_by?: SortMetric
    • Optionaldevice_type?: { limit?: number; sort_by?: SortMetric }

      Request device type breakdown.

      • Optionallimit?: number

        Maximum number of entries to return. When omitted, all entries are returned (the enum is small and bounded).

      • Optionalsort_by?: SortMetric
    • Optionaldevice_platform?: { limit?: number; sort_by?: SortMetric }

      Request device platform breakdown.

      • Optionallimit?: number

        Maximum number of entries to return. When omitted, all entries are returned (the enum is small and bounded).

      • Optionalsort_by?: SortMetric
    • Optionalaudience?: { limit?: number; sort_by?: SortMetric }

      Request audience segment breakdown.

      • Optionallimit?: number

        Maximum number of entries to return. Defaults to 25.

      • Optionalsort_by?: SortMetric
    • Optionalplacement?: { limit?: number; sort_by?: SortMetric }

      Request placement breakdown.

      • Optionallimit?: number

        Maximum number of entries to return. Defaults to 25.

      • Optionalsort_by?: SortMetric
    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties