Reports
Generate and retrieve AI visibility intelligence reports. Reports include metrics, competitive analysis, wins/losses, and strategic recommendations.
List Reports
Returns paginated reports for a brand, ordered by creation date (newest first). Use report_id to fetch a single report with its full data snapshot.
Query Parameters
brand_idstringrequiredBrand UUID from /get-brands (required unless report_id is provided)
report_idstringReport UUID to retrieve a single report with full data
report_typestringFilter by type: executive, weekly, full, intelligence
statusstringFilter by status: pending, generating, completed, failed, expired
limitintegerResults per page (1-100)
Default: 20
offsetintegerPagination offset
Default: 0
Get Report Detail
When report_id is provided, returns a single report including the full report_data snapshot with metrics, competitive analysis, and recommendations.
report_data field is only included in single-report responses. List responses omit it to keep payloads small.Response Fields
Report Object
idstringUnique report identifier
brand_idstringBrand this report belongs to
report_typestringType of report: executive, weekly, full, intelligence
report_namestringnullableHuman-readable report name
time_rangestringAnalysis period (7d, 14d, 30d)
statusstringGeneration status: pending, generating, completed, failed, expired
file_urlstringnullableDownload URL for the generated PDF
file_size_bytesintegernullableFile size in bytes
page_countintegernullableNumber of pages in the PDF
error_messagestringnullableError details if generation failed
created_atstringISO 8601 creation timestamp
expires_atstringnullableISO 8601 expiration timestamp (reports expire after 30 days)
report_data Object (single report only)
metricsobjectVisibility, rank, and presence scores with changes and trends
competitiveobjectCompetitor leaderboard, position, and threat analysis
wins_lossesarrayPrompt-level ranking changes (improvements and declines)
recommendationsarrayAI-generated strategic recommendations with priority, effort, and impact
platformsobjectPer-platform visibility breakdown (ChatGPT, Claude, Perplexity, etc.)
executiveobjectExecutive narrative, headline, key insight, and priority action
Generate Report
Generates a new AI intelligence report for the brand. The report is created synchronously and includes visibility metrics, competitive analysis, wins/losses, and AI-generated strategic recommendations.
Request Body
brand_idstringrequiredBrand UUID
report_typestringReport type: executive, weekly, or full
Default: executive
time_rangestringAnalysis period: 7d, 14d, or 30d
Default: 7d
Report Types
| Type | Description |
|---|---|
executive | Concise executive summary with key metrics and actions |
weekly | Weekly performance review with trend analysis |
full | Comprehensive report with all sections and detailed data |
