Skip to main content

Get Optimizer Settings

GET 

/api/advertising/optimizer/settings

Returns the bid optimizer's mode, whether auto mode is unlocked, and the latest bid-model backtest.

Required scope: advertising:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Requires the advertising.view permission; the tenant must have the advertising-manager feature enabled.

Modes: off (no scheduled runs), monitor (estimates only, no change sets), suggest (each run creates a pending change set for review), auto (change sets are applied without review).

Response fields:

  • optimizer_mode: the stored mode (off, monitor, suggest, auto; default monitor).
  • effective_mode: the mode runs actually use; a stored auto runs as suggest once the passing backtest is older than the validity window (30 days by default).
  • auto_unlocked: whether the latest backtest beats the baseline and is recent enough to allow auto.
  • auto_blocked_reason: why auto is not available (null when unlocked).
  • backtest: the latest backtest result or null: outcome (passed, failed, insufficient_data), ran_at, ad_account_ids, targets_evaluated, calibration error for the model and for raw per-target conversion rates (lower is better), calibration_buckets, contribution of the model's bids vs the bid-to-target-POAS rule, lift_pct, beats_baseline, message.

Request​

Responses​

OK

Response Headers
    Content-Type