Capability reference

Every capability an API key can call, what it returns, and the scopes that grant it. A key needs any one of the listed scopes. All capabilities work on the key's project only.

To see what a specific key can call, use GET /v1/capabilities, or let your MCP client list its tools.

Setup

Capability	Returns	Scopes
`searchEntities`	Finds personas, competitors, monitors and prompts by name and returns their IDs. Suggests close matches when a name is misspelled	Analytics Read
`getProjectOverview`	Brand, domain, country, and the number of monitors, prompts, competitors and personas	Analytics Read, Monitors Read
`listMonitors`	Your monitors and their status	Analytics Read, Monitors Read
`listPersonas`	Your buyer personas with conversion potential and key pain point	Analytics Read, Monitors Read
`listPrompts`	Your tracked prompts, filterable by country, monitor, type, intent or persona	Analytics Read, Monitors Read

Prompts and AI answers

Capability	Returns	Scopes
`getPromptAnswers`	The recorded AI answers for one prompt, with brand mentions, citation share and sentiment	Analytics Read, Monitors Read
`getPromptExecutionHistory`	One prompt's runs, mention rate, response time, results per AI model and daily batches	Analytics Read, Monitors Read

Scores and competitors

Capability	Returns	Scopes
`getRankings`	Current visibility, share of voice, position, citation share and sentiment scores	Analytics Read
`getBrandPerformance`	Daily trend of those scores	Analytics Read
`getCompetitorComparison`	Your scores next to your tracked competitors' scores	Analytics Read, Competitors Read
`getSentiment`	Your brand's sentiment score and how many answers it is based on	Analytics Read

Citations

Capability	Returns	Scopes
`getCitationStats`	Total citations, top citing domains, and the split between your domain, competitors and third parties	Analytics Read, Citations Read
`findCitations`	The prompts and AI providers where a given domain was cited	Analytics Read, Citations Read
`listCitedUrls`	The most cited URLs with domain, citation count and owner type	Analytics Read, Citations Read
`getCitedUrlDetails`	Which prompts and AI models cited one URL	Analytics Read, Citations Read

Buying simulations

Capability	Returns	Scopes
`getBuyingSimulationStats`	Your win rate, filterable by persona, country or date	Analytics Read
`listRecentBuyingSimulations`	Recent completed simulations, newest first	Analytics Read
`getBuyingSimulationDetails`	One simulation's winner, persona, location, transcript excerpts and report	Analytics Read
`getBuyingSimulationSummary`	A summary of a run: outcome, win-rate context and the competitors that won	Analytics Read
`getBuyingSimulationScheduleAnalysis`	The full run history of one simulation schedule	Analytics Read
`searchBuyingSimulationSchedules`	Schedules found by persona, question, AI engine or country	Analytics Read
`compareBuyingSimulationSchedules`	Two AI engines compared: win rates, content gaps and recommendations	Analytics Read
`getBuyingSimulationReportInsights`	Content gaps and recommendations combined across simulation reports	Analytics Read

Buying simulation cockpit

These need a project on the current buying-simulation version. Otherwise they return a 503 unavailable error.

Capability	Returns	Scopes
`getCockpitPresence`	How often your brand appears in buying conversations	Analytics Read
`getCockpitShareOfVoice`	Your share of vendor mentions compared with competitors	Analytics Read
`getCockpitWinByAssistant`	Your win rate per AI assistant	Analytics Read
`getCockpitSourceLandscape`	The domains AI assistants cite in buying conversations	Analytics Read
`getCockpitMomentum`	The trend of presence, recommendations and win rate	Analytics Read
`getCockpitEvidence`	The strongest recent answer where your brand won	Analytics Read

Content and pages

Capability	Returns	Scopes
`listContentActions`	Your content actions by priority, as on the Content Actions page	Analytics Read
`listContentLog`	Pages you published or changed, newest first	Analytics Read
`updateContentActionStatus`	Sets one content action's status. See "Capabilities API reference"	Content Actions Write
`listOurPages`	Your own pages, with AI citations and AI crawler visits	Analytics Read
`getOurPagesSummary`	How many of your pages AI cited or visited, over up to 90 days	Analytics Read

Server logs

Capability	Returns	Scopes
`getServerLogStats`	Log lines processed and AI crawler traffic from your uploaded server logs	Analytics Read, Server Logs Read

Notes

getSentiment needs sentiment to be enabled for your project. Otherwise it returns a 503 unavailable error.
searchEntities also returns competitors, so it needs Analytics Read.
API keys cannot create Copilot drafts or send Slack or Teams messages. Those are only available in Copilot inside Ansehn.

Was this helpful?