Monitoring & Reporting Write
Schedule recurring performance briefs delivered to your inbox
POST https://api.adspirer.ai/api/v1/tools/schedule_brief/execute
Authorization: Bearer sk_live_... — your Adspirer API key (required)Content-Type: application/json (required)Idempotency-Key: <uuid> — recommended for write operations to make retries safeAll tool arguments are wrapped in an arguments object.
| Field | Type | Description |
|---|---|---|
name | string required | Name for this scheduled brief (e.g., 'Daily Performance Summary') |
schedule_type | string optional | How often to send: 'daily', 'weekly', or 'every_n_days' default: "weekly" |
time | string optional | Time to send (24-hour format, e.g., '09:00' for 9 AM) default: "09:00" |
timezone | string optional | Timezone (e.g., 'America/New_York', 'Europe/London', 'Asia/Tokyo') default: "America/New_York" |
platforms | array optional | Platforms to include: 'google_ads', 'meta_ads', 'tiktok_ads', 'linkedin_ads'. Default is all connected. |
delivery_method | string optional | How to deliver: 'email', 'slack', or 'webhook' default: "email" |
delivery_destination | string required | Email address, Slack channel, or webhook URL |
{
"arguments": {
"name": "string",
"delivery_destination": "https://example.com",
"schedule_type": "weekly",
"time": "09:00",
"timezone": "America/New_York",
"platforms": [
"string"
],
"delivery_method": "email"
}
}
{
"success": true,
"data": {
"text": "(tool-specific textual output for schedule_brief)",
"quota": {
"used": 42,
"limit": 150,
"tier": "plus",
"period_end": "2026-05-01"
}
},
"tool": "schedule_brief"
}
{
"success": false,
"error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n - Acme Holdings (ad_account_id=\"act_123456789\")\n - Acme EU (ad_account_id=\"act_987654321\")",
"is_error": true,
"tool": "schedule_brief"
}
{
"success": false,
"error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
"is_error": true,
"tool": "schedule_brief",
"quota": {
"used": 150,
"limit": 150,
"tier": "plus",
"period_end": "2026-05-01",
"upgrade_url": "https://adspirer.ai"
}
}
Interactive: Swagger UI
Machine-readable: OpenAPI 3.1 spec · llms-full.txt
More tools: Monitoring & Reporting · All tools
Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai