business-reports

Generate Report

Generate an on-demand business impact report.

Aggregates data from GSC, GA4, and Shopify (when connected), then calls Gemini to produce a narrative summary. The finished report is persisted and returned.

post/sites/{site_id}/reports/generate

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/generate
  • Auth: API key in header X-Agent-Key

Path parameters

site_idstring uuid required

Query parameters

emailstring nullable

Request body

period_typestring required

weekly, monthly, or custom

period_startstring date-time required
period_endstring date-time required
comparison_modestring

previous_period or previous_year

brand_termsstring[]
comparison_startstring date-time nullable
comparison_endstring date-time nullable
comparison_enabledboolean
data_onlyboolean

Response

Successful Response

idstring uuid required
site_idstring uuid required
period_typestring required
period_startstring date-time required
period_endstring date-time required
statusstring required
gsc_dataobject nullable
ga_dataobject nullable
shopify_dataobject nullable
keyword_funnelobject nullable
traffic_insightsobject nullable
report_metadataobject nullable
source_statusobject nullable
narrativestring nullable
email_sent_atstring date-time nullable
delivery_statusstring nullable
delivery_errorstring nullable
created_atstring date-time required

Changes

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