URL Citation Report
get_urls_reportRetrieve URL analytics reports including citation counts, retrievals, and citation rates. Filter by date, classification, dimensions, and other criteria to analyze brand visibility in AI-generated answers.
Instructions
Get URL analytics report: citation_count (total citations), retrievals (retrieval count), citation_rate. Classification values: HOMEPAGE, CATEGORY_PAGE, PRODUCT_PAGE, LISTICLE, COMPARISON, PROFILE, ALTERNATIVE, DISCUSSION, HOW_TO_GUIDE, ARTICLE, 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.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_urls_report"
}
}Input 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 URL 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 |