Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | Brand ID from ocoya_list_brands. |
status | string | No | Only campaigns with this status: GENERATING, GENERATED, SCHEDULED or ERROR. |
page | number | No | Zero-based page number. Defaults to 0. |
perPage | number | No | Campaigns per page, up to 100. Defaults to 20. |
Request example
{
"name": "ocoya_list_campaigns",
"arguments": {
"brandId": "cmayvq3hk00017apshay5qezu",
"status": "GENERATED",
"page": 0,
"perPage": 20
}
}Returns
Returns total, page, perPage and data, the campaigns on this page. Each campaign has:
| Field | Description |
|---|---|
id | Campaign ID. Pass it to ocoya_get_campaign. |
type | social or blog. |
name, prompt | The brief the campaign was generated from. The app shows it as the campaign’s name. |
goal | Campaign objective, when one was set. |
status | GENERATING while posts are being written, GENERATED when they are ready to review, SCHEDULED once the campaign runs (shown as Running in Ocoya), ERROR when generation failed. |
duration, startDate, postsPerDay | The campaign’s schedule. |
plannedPostCount, postCount | Posts asked for, and posts generated so far. |
channelIds | Channels the campaign posts to. |
generation | Progress while generating: phase, current, total, completed, failed, and error when it failed. |
createdAt, updatedAt | Timestamps. |
This tool only reads: it changes nothing in Ocoya. It needs the posts:read scope.