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

    Interface GetSignalsResponse

    Response payload for get_signals task

    interface GetSignalsResponse {
        signals: {
            signal_id?: SignalID;
            signal_agent_segment_id: string;
            name: string;
            description: string;
            value_type?: SignalValueType;
            categories?: string[];
            range?: { min: number; max: number };
            signal_type: SignalCatalogType;
            data_provider: string;
            coverage_percentage: number;
            deployments: Deployment[];
            pricing_options: SignalPricingOption[];
        }[];
        errors?: Error[];
        pagination?: PaginationResponse;
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    signals: {
        signal_id?: SignalID;
        signal_agent_segment_id: string;
        name: string;
        description: string;
        value_type?: SignalValueType;
        categories?: string[];
        range?: { min: number; max: number };
        signal_type: SignalCatalogType;
        data_provider: string;
        coverage_percentage: number;
        deployments: Deployment[];
        pricing_options: SignalPricingOption[];
    }[]

    Array of matching signals

    Type Declaration

    • Optionalsignal_id?: SignalID
    • signal_agent_segment_id: string

      Opaque identifier used for activation. This is the signals agent's internal segment ID.

    • name: string

      Human-readable signal name

    • description: string

      Detailed signal description

    • Optionalvalue_type?: SignalValueType
    • Optionalcategories?: string[]

      Valid values for categorical signals. Present when value_type is 'categorical'. Buyers must use one of these values in SignalTargeting.values.

    • Optionalrange?: { min: number; max: number }

      Valid range for numeric signals. Present when value_type is 'numeric'.

      • min: number

        Minimum value (inclusive)

      • max: number

        Maximum value (inclusive)

    • signal_type: SignalCatalogType
    • data_provider: string

      Human-readable name of the data provider

    • coverage_percentage: number

      Percentage of audience coverage

    • deployments: Deployment[]

      Array of deployment targets

    • pricing_options: SignalPricingOption[]

      Pricing options available for this signal. The buyer selects one and passes its pricing_option_id in report_usage for billing verification.

    errors?: Error[]

    Task-specific errors and warnings (e.g., signal discovery or pricing issues)

    pagination?: PaginationResponse
    sandbox?: boolean

    When true, this response contains simulated data from sandbox mode.

    context?: ContextObject
    ext?: ExtensionObject