Skip to main content

OptimizationObjective

A stop condition: the run stops when the plan reaches value on the metric named by type. Send at most one objective per type; if a type is repeated, the last one is used.

typestringrequired

Metric the objective is measured on (case-insensitive). Any other value returns 400 AE_ERR_401.

Enum ValueDescription
CONTACTSTotal contacts of the plan, in the same unit as stats.contacts.
GRPGross rating points of the plan.
COVERAGEPeople of the target reached at least once, in the same unit as stats.cover.
COVERAGE_PERCENTCoverage as a percentage (0 to 100) of the universe of the target.
BUDGETNet cost of the plan, in the currency of the workspace prices.

Possible values: [CONTACTS, GRP, COVERAGE, COVERAGE_PERCENT, BUDGET]

valuenumber<double>required

Threshold to reach, in the unit of type. Use a number greater than 0: a value of 0 or less is accepted but never stops the run.

OptimizationObjective
{
"type": "CONTACTS",
"value": 0
}