Create scheduled report
Set up a recurring PDF report from a SpyFu page, emailed to the recipients you name.
POST https://cotlet.dev/api/v1/spyfu/scheduled-reports
write Confirm
Does what Create Report with the email and schedule options does: builds the report from one SpyFu page for a domain or keyword and sets up recurring emails to the recipients. It includes every section of the page unless you list some in exclude_sections. schedule is the label of an option in SpyFu's report dialog. A custom title is a white label feature that SpyFu limits to certain plans. The PDF goes to people outside your account. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| page string required | string | Page the report is made from, as SpyFu names it, for example Domain Overview, SEO Keywords, Ranking History, Ad History. |
| subject string required | string | Domain or keyword the report is about. |
| recipients string required | string | Comma-separated email addresses. |
| schedule string required | string | Label of an option in the report dialog, for example Monthly. |
| title string | string | Title for the front page of the PDF. |
| exclude_sections string | string | Comma-separated section names to leave out of the PDF. |
Request
curl -X POST https://cotlet.dev/api/v1/spyfu/scheduled-reports \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"page":"Domain Overview","subject":"trailkick.com","recipients":"maria@trailkick.com","schedule":"Monthly","title":"Trailkick monthly SEO recap"}'result = client.call("spyfu", "create_scheduled_report", {"page":"Domain Overview","subject":"trailkick.com","recipients":"maria@trailkick.com","schedule":"Monthly","title":"Trailkick monthly SEO recap"})const result = await cotlet.call('spyfu', 'create_scheduled_report', {"page":"Domain Overview","subject":"trailkick.com","recipients":"maria@trailkick.com","schedule":"Monthly","title":"Trailkick monthly SEO recap"});cotlet call spyfu create_scheduled_report --data '{"page":"Domain Overview","subject":"trailkick.com","recipients":"maria@trailkick.com","schedule":"Monthly","title":"Trailkick monthly SEO recap"}'Example response
{
"report_id": "rep_3f9a1c",
"page": "Domain Overview",
"subject": "trailkick.com",
"recipients": [
"maria@trailkick.com"
],
"schedule": "Monthly",
"status": "scheduled"
}