Skip to main content
v1.0GuidesGuidesAPI ReferenceAPI Reference

Scenarios

GET 
/resource/marketing-mix-modeling/scenarios
GEThttps://api2.sonalabs.com/resource/marketing-mix-modeling/scenarios

Retrieve the Scenario Planner runs of your organization, newest first.

A scenario is a what-if on a KPI's model: the same data with paid-channel spend changed, refitted as its own model. Read a scenario's results with resource/marketing-mix-modeling/scenarios/{scenarioId}.

scenario holds what the scenario was created with. Only one of shifts and allocations is filled, depending on planner.plannerMode:

  • shifts - manual mode: monthly amounts moved from one paid channel to another. Empty in auto mode.
  • allocations - auto mode: the new monthly spend of each paid channel. Empty in manual mode.
  • planner - the Scenario Planner settings: plannerMode (manual or auto), budgetConstraintType (fixed - spread the monthly autoBudget across channels - or flexible - reach a flexTargetValue of total revenue or overall ROI, per flexTargetType), and bounds: how far each channel's spend may move from its current level, as min/max percentages keyed by channel key (empty when no limits were set).

Calling this endpoint does not consume credits.

Request​

Responses​

Success