MCP tools

Get KPI targets

Returns the active brand's KPI targets: for each metric, the value the brand aims for, whether a person confirmed it in Koast or it is still a proposal, where it is measured, the day it applies from, and the breakeven when the brand's economics give one.

Tool name: get-kpi-targets.

Returns the active brand's KPI targets: for each metric, the value the brand aims for, whether a person confirmed it in Koast or it is still a proposal, where it is measured, the day it applies from, and the breakeven when the brand's economics give one. A proposal (status INFERRED) is not in force. Set includeHistory to also see earlier versions. Read-only.

When to use

Before judging whether results are good, to compare them with what the brand aims for, and before proposing a target, to see what already exists.

Access

PropertyValue
Required scoperead
PublishesNo
Read-onlyYes
DestructiveNo
IdempotentYes
Open worldNo

Input

FieldTypeRequiredDescription
includeHistorybooleanNoTrue to also list earlier versions: what applied before, and proposals that were replaced. Default false.

Output

FieldTypeRequiredDescription
targetsobject[]YesThe open version of each metric's target.
historyobject[] | nullYesEarlier versions, newest first; null unless includeHistory was true.

REST equivalent

MCP only. No REST operation does the same thing.

On this page