API
Resources
Choose the right API resource for each reporting need.
GET /api/v1 returns the live resource index. The current public resources
are:
| Resource | Use it for |
|---|---|
/prompts | Tracked buyer questions. |
/locations | Markets and language/location context. |
/engines | Active AI engines and provider configuration. |
/brands | Target and competitor brand records. |
/competitors | Target-to-competitor relationships. |
/measurement-windows | Tracking snapshots. |
/runs | Individual engine answers. |
/citations | URLs cited in answers. |
/sources | Search results or sources consulted. |
/brand-detections | Per-run brand mention/citation/source detection. |
/aggregate-scores | Headline visibility metrics. |
/recommendations | Optimization recommendations. |
/geo-audits | GEO audit scores. |
/crawler-events | Daily AI crawler visits captured from your tracked sites. |
Recommended joins
Use IDs to join exported data in BI tools:
query_idconnects prompts, runs, aggregate scores, and recommendations.measurement_window_idconnects windows, runs, aggregates, and recommendations.run_idconnects runs, citations, sources, and brand detections.brand_idconnects brands, detections, aggregates, and recommendations.
Child resources
citations, sources, and brand-detections are scoped to runs. When you
need a measurement-window export for those resources, fetch runs for the
window first and then use run_id to retrieve the child records.