Optimization
Let the optimization engine build a media plan. You give it candidate carriers with optional per-carrier constraints and prices, a criterion (COVERAGE or COVERAGE_PER_CPM) and one or more stop objectives (budget, GRP, contacts, coverage); it adds insertions step by step and returns the last plans it kept. Optimization is asynchronous: submit a job (202 and a jobId), poll its status, then fetch the result. A user can run one optimization at a time (a job that starts while another one of the same user is active ends FAILED), can have up to 50 queued background jobs (429 beyond that), each run lasts at most one hour, and results are kept for 30 days. Jobs belong to the API key's user and also appear in the TOM web application's background-jobs panel. Requires the Study module.
📄️ Get the status of an optimization
Returns the current status of a media plan optimization job, with the timestamps of its life cycle.
📄️ Get the result of an optimization
Returns the outcome of a succeeded optimization: the plans of the last (up to) three iterations, why the run stopped and the state of each objective.
📄️ Submit a media plan optimization
Submits a media plan optimization for one survey and immediately returns a job identifier; the optimization itself runs in the background.