Insights

Get the optimization plan

GET
/api/v1/accounts/{projectId}/plan

The operator's targets, pacing against the daily spend goal, CPA versus the configured band, and a ranked action feed grouped into scale / expand / protect / reallocate. This is also the cheapest read for the account's optimization targets. Work the feed top-down and act on an item with the matching endpoint under Actions.

Required scope: read.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from Workspace → Settings → API keys, sent as Authorization: Bearer tsk_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see state. Never changes anything.
  • write — propose changes (the actions/* endpoints), trigger audits and reports.
  • admin — connection, account import, sync, targets and brief.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Deciding a queued proposal — approve, reject, revert — needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

A key is either org-scoped (reaches every account, optionally limited to a subset) or bound to a single account.

In: header

Path Parameters

projectId*string

The account's project UUID — from GET /accounts, NOT the Apple asaOrgId. Pass the literal current with an account-scoped key to use its bound account.

Query Parameters

group?string

Filter the feed to one group.

Default"all"

Value in

  • "all"
  • "scale"
  • "expand"
  • "protect"
  • "reallocate"
  • "explore"
limit?integer

Feed items to return.

Range1 <= value <= 25
Default10

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/accounts/current/plan"
{  "plan": {    "targets": {},    "pacing": {},    "feed": [      {}    ]  },  "dataFreshness": {    "lastSyncAt": "2019-08-24T14:15:22Z",    "ageHours": 0,    "coverage": "string",    "warning": "string"  }}