OptimizationResultResponse
Retained plans, total iterations and stop reason.
plans object[]required
The plans of the last iterations, oldest first: between one and three. The last one is the final plan.
Possible values: >= 1, <= 3
Iteration that produced this plan, starting at 1.
Possible values: >= 1
stats objectrequired
Aggregated statistics of this plan, computed for the target of the request.
People of the target reached at least once by the plan, as an absolute figure.
cover as a percentage (0 to 100) of the universe of the target.
Gross rating points of the plan.
Total contacts of the plan in the target, as an absolute figure.
Net (discounted) cost of the plan: the value compared with a BUDGET objective.
Sum of the insertions of all the carriers of the plan.
Not currently returned by the API.
Not currently returned by the API.
Not currently returned by the API.
Maximum cover reachable with all the candidate carriers.
Not currently returned by the API.
Not currently returned by the API.
Net cost per thousand contacts.
Net cost per GRP point.
Not currently returned by the API.
carriers object[]required
Insertions assigned to each carrier in this plan.
Identifier of the carrier, as sent in carriers[].id of the request.
Insertions assigned to this carrier in this plan.
Number of iterations the engine executed. Only the last ones are returned in plans.
Why the run stopped. Switch on this value; do not parse messages. With OBJECTIVE_REACHED, see objectives for the ones that were met.
| Enum Value | Description |
|---|---|
| OBJECTIVE_REACHED | The last plan reached at least one objective. |
| DURATION_CAP_REACHED | The run was stopped after 3600 seconds of execution; the plans are the best found until then. |
| NO_FURTHER_IMPROVEMENT | The engine could not improve the plan further. |
| ENGINE_ERROR | The run stopped for another reason after producing at least one plan; the plans may be far from the objectives. |
Possible values: [OBJECTIVE_REACHED, DURATION_CAP_REACHED, NO_FURTHER_IMPROVEMENT, ENGINE_ERROR]
objectives object[]
State, at the final plan, of each objective of the request with a value greater than 0. More than one objective can be reached at once.
Metric of the objective, with the same values as type in the request.
Possible values: [CONTACTS, GRP, COVERAGE, COVERAGE_PERCENT, BUDGET]
The value requested for this objective.
Value the final plan achieved for this metric. It can be absent.
achieved / target x 100, without a cap: it can exceed 100.
Whether the objective was met: achieved is at least target.
{
"plans": [
{
"iteration": 0,
"stats": {
"cover": 0,
"coverPercent": 0,
"grp": 0,
"contacts": 0,
"cost": 0,
"totalInsertions": 0,
"affinity": 0,
"affinityIndex": 0,
"ots": 0,
"coverMax": 0,
"coverMaxPercent": 0,
"fidelity": 0,
"cpmContacts": 0,
"costPerGrp": 0,
"cpmIndividuals": 0
},
"carriers": [
{
"id": "string",
"insertions": 0
}
]
}
],
"totalIterations": 0,
"stopReason": "OBJECTIVE_REACHED",
"objectives": [
{
"type": "CONTACTS",
"target": 0,
"achieved": 0,
"completedPercent": 0,
"reached": true
}
]
}