Domain Citation Report
get_domains_reportRead-onlyIdempotent
Retrieve domain analytics report with metrics like retrieval rate, citation rate, and retrieved percentage. Filter by classification, date, and dimensions for tailored analysis.
Instructions
Get domain analytics report: retrieval_rate, citation_rate, and retrieved_percentage. Classification values: OWN, CORPORATE, COMPETITOR, EDITORIAL, REFERENCE, INSTITUTIONAL, UGC, OTHER. Returns up to limit results (default: 100). Classification is filtered client-side after retrieval. Use filters array for server-side filtering by model, tag, topic, prompt, domain, URL, or country_code. Without date filters, returns data across all available dates. Empty results may indicate the project has no report data for the given time range or filters.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | No | Project ID (uses PEECAI_PROJECT_ID env if omitted). Call list_projects to find IDs. | |
| start_date | No | Start date (YYYY-MM-DD). Omit for no lower bound. | |
| end_date | No | End date (YYYY-MM-DD). Omit for no upper bound. | |
| dimensions | No | Breakdown dimensions. Each adds a grouping level to results: prompt_id (by search prompt), model_id (by AI model), model_channel_id (by model channel, e.g. openai-0/perplexity-0), tag_id (by category tag), topic_id (by topic group), date (by date), country_code (by country), chat_id (by individual chat). Multiple dimensions can be combined. | |
| classification | No | Filter by domain classification (applied client-side after retrieval). | |
| filters | No | Server-side filters. Multiple filters are AND'd together. | |
| limit | No | Max results (1-10000, default: 100) | |
| offset | No | Results to skip |