project_id. Always call get_all_projects first to get your project ID.
Common Parameters
Most tools share these optional parameters:| Parameter | Type | Description |
|---|---|---|
project_id | string | Required. Your project ID from get_all_projects |
filters | object | Narrow results by topic, market, model, etc. |
order_by | array | Sort results, e.g. [{"field": "visibility_score", "order": "desc"}] |
pagination | object | Limit results, e.g. {"limit": 10, "offset": 0} |
metrics | array | Request additional computed fields in the response |
Data Fetching Tools
These tools return lists of individual records.get_all_projects
List all projects accessible to the authenticated user. Call this first — every other tool requires theproject_id returned here.
get_all_prompts
Fetch all tracked search queries (prompts) with visibility scores, mention counts, and performance indicators. Use this to discover which queries are being monitored.get_all_topics
Fetch topic categories that group related prompts. Use topic IDs for filtering in other tools.get_all_tags
Fetch custom tag labels applied to prompts. Use tag IDs for filtering in other tools.get_all_citations
Fetch individual citation URLs where the brand was referenced in AI responses. For aggregated counts, usequery_citation_report instead.
get_all_websites
Fetch all tracked websites (your brand + competitors). Use this for competitive benchmarking and to get website IDs for filtering.get_all_keywords
Fetch keywords found in AI responses related to the brand. Useful for content strategy and understanding brand perception.get_all_models
Fetch all tracked AI platforms (ChatGPT, Perplexity, Claude, Gemini, etc.) with per-platform metrics.get_all_markets
Fetch all geographic markets being tracked. Use market IDs for filtering in report queries.get_all_domains
Fetch citing domains aggregated by domain. Unlikeget_all_citations which returns individual URLs, this provides a higher-level view.
Report Query Tools
These tools return aggregated metrics grouped by dimensions you specify.Common Report Parameters
| Parameter | Type | Description |
|---|---|---|
project_id | string | Required. |
dimensions | array | Required. Group by: topic, market, model, prompt, tag, date, website |
date_aggregation_interval | string | day, week, or month — only applies when date is in dimensions |
website_type | string | SELF (your brand only) or SELF+COMPETITORS (all tracked websites) |
filters | object | Narrow by topic, market, model, etc. |
order_by | array | Sort results |
pagination | object | Limit results |
query_performance_report
Aggregated performance metrics: share of voice, citation share, visibility score, and mention counts. This is the main analytics tool for understanding brand performance. Example dimension combinations:["date"]withmonthinterval — monthly visibility trend["model"]withwebsite_type: "SELF"— per-platform brand performance["topic", "date"]— topic performance over time["website", "market"]— compare brand vs competitors by region
query_citation_report
Aggregated citation metrics: citation counts, unique pages, and unique domains grouped by dimensions. Example dimension combinations:["model"]withwebsite_type: "SELF"— citations by AI platform["date"]withmonthinterval — citation trend over time["model", "domain"]— top citing domains per AI model
query_sentiment_report
Sentiment analysis metrics: keyword occurrences and positive sentiment scores. Example dimension combinations:["model"]withwebsite_type: "SELF"— sentiment by AI platform["date"]withmonthinterval — sentiment trend["topic"]— sentiment breakdown by topic