---
title: "Generate Report"
method: POST
path: "/sites/{site_id}/reports/generate"
tags: ["business-reports"]
---

# Generate Report

`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`

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.

## Path parameters

- `site_id` string, uuid, required

## Query parameters

- `email` string, nullable

## Request body

- GenerateReportRequest
  - `period_type` string, required: weekly, monthly, or custom
  - `period_start` string, date-time, required
  - `period_end` string, date-time, required
  - `comparison_mode` string: previous_period or previous_year
  - `brand_terms` string[]
  - `comparison_start` string, date-time, nullable
  - `comparison_end` string, date-time, nullable
  - `comparison_enabled` boolean
  - `data_only` boolean

## Response `200`

Successful Response

- ReportOut
  - `id` string, uuid, required
  - `site_id` string, uuid, required
  - `period_type` string, required
  - `period_start` string, date-time, required
  - `period_end` string, date-time, required
  - `status` string, required
  - `gsc_data` object, nullable
  - `ga_data` object, nullable
  - `shopify_data` object, nullable
  - `keyword_funnel` object, nullable
  - `traffic_insights` object, nullable
  - `report_metadata` object, nullable
  - `source_status` object, nullable
  - `narrative` string, nullable
  - `highlights` unknown[], nullable
    - unknown
  - `recommendations` unknown[], nullable
    - unknown
  - `email_sent_at` string, date-time, nullable
  - `delivery_status` string, nullable
  - `delivery_error` string, nullable
  - `created_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/xeorank/apis/seo-intelligence-engine.md) · [All operations](https://skmtc.dev/xeorank/apis/seo-intelligence-engine/llms.txt) · [OpenAPI document](https://skmtc.dev/xeorank/apis/seo-intelligence-engine/revisions/449a3fd73454?raw)