business-reports

Upsert Schedule

Create or update the report schedule for a site.

Requires the scheduled_reports feature flag on the user's plan.

put/sites/{site_id}/reports/schedule

Request

  • Base URL: https://api.xeorank.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.xeorank.com/sites/{site_id}/reports/schedule
  • Auth: API key in header X-Agent-Key

Path parameters

site_idstring uuid required

Query parameters

emailstring nullable

Request body

frequencystring required

weekly, monthly, or both

is_activeboolean
day_of_monthinteger
recipientsstring[]
timezonestring
brand_termsstring[]

Response

Successful Response

idstring uuid required
site_idstring uuid required
frequencystring required
is_activeboolean required
day_of_monthinteger nullable
timezonestring
last_weekly_run_atstring date-time nullable
last_monthly_run_atstring date-time nullable
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.