campaign_plan_list
List the campaign plans in your organization, with the money figures you would rank them by.
Lists the Campaign Plans of your organization, newest first: what you intend to run, on which channels, for how much, over what period.
Input
Plans are always scoped to your active organization.
| Field | Type | Required | Description |
|---|---|---|---|
limit |
number |
no | The greatest number of rows in the answer, from 1 to 500. The default is 100. |
cursor |
string |
no | The nextCursor of the previous answer. Omit it to get the first page. |
Output
{ campaignPlans: [...], nextCursor? }. When nextCursor is present, more plans exist: call campaign_plan_list again with cursor set to that value.
Each plan comes back as summary facts rather than its contents — the Line Items themselves come from campaign_plan_get.
| Field | Description |
|---|---|
slug |
The stable handle every other tool takes. |
name, description |
What it is, in a line. |
currency |
ISO 4217. Every amount on the plan is in whole units of it. |
totalBudget |
The envelope — what you have. null means no declared constraint, which is not zero. |
allocation |
allocated (what you have placed), unallocated (the remainder), unit, and comparable. |
startDate, endDate |
Either may be null; a null end means always-on. |
status |
draft or approved. |
lineItemCount, channels |
How many rows, and which channels they touch. |
Errors
invalid_cursor— thecursoris not anextCursorof this tool, with the same arguments. Send it with no change, or omit it.
Requires the campaign_plan:read scope.