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

    Type Alias GetSignalsRequest

    GetSignalsRequest: { [k: string]: unknown } & {
        adcp_major_version?: number;
        account?: AccountReference;
        signal_spec?: string;
        signal_ids?: SignalID[];
        destinations?: Destination[];
        countries?: string[];
        filters?: SignalFilters;
        max_results?: number;
        pagination?: PaginationRequest;
        context?: ContextObject;
        ext?: ExtensionObject;
    }

    Request parameters for discovering and refining signals. Use signal_spec for natural language discovery, signal_ids for exact lookups, or both to refine previous results (signal_ids anchor the starting set, signal_spec guides adjustments).

    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

    • Optionalaccount?: AccountReference
    • Optionalsignal_spec?: string

      Natural language description of the desired signals. When used alone, enables semantic discovery. When combined with signal_ids, provides context for the agent but signal_ids matches are returned first.

    • Optionalsignal_ids?: SignalID[]

      Specific signals to look up by data provider and ID. Returns exact matches from the data provider's catalog. When combined with signal_spec, these signals anchor the starting set and signal_spec guides adjustments.

    • Optionaldestinations?: Destination[]

      Filter signals to those activatable on specific agents/platforms. When omitted, returns all signals available on the current agent. If the authenticated caller matches one of these destinations, activation keys will be included in the response.

    • Optionalcountries?: string[]

      Countries where signals will be used (ISO 3166-1 alpha-2 codes). When omitted, no geographic filter is applied.

    • Optionalfilters?: SignalFilters
    • Optionalmax_results?: number

      DEPRECATED: Use pagination.max_results instead. When both fields are present, agents MUST honor pagination.max_results. When only this field is present without a pagination envelope, agents SHOULD treat it as the page size subject to a maximum of 100 results. This field will be removed in AdCP 4.0.

      1

    • Optionalpagination?: PaginationRequest
    • Optionalcontext?: ContextObject
    • Optionalext?: ExtensionObject