Using the tools
#The server provides 141 JSON tools before permission filtering. Tool names match the API's operation IDs; open a tool's reference for its inputs. Read-only tools only read data; tools marked "Changes data" create, edit, delete, run or publish, within the permissions of your key.
The answers CSV export stays a streaming REST endpoint.
Workspace
#| Tool | Access | What it does |
|---|---|---|
getWorkspace | Read-only read | Read workspace plan, limits, and usage |
Models
#| Tool | Access | What it does |
|---|---|---|
listEngines | Read-only read | List active measurement engines |
setProjectEngines | Changes data write | Select measurement engines within plan entitlements |
Projects
#| Tool | Access | What it does |
|---|---|---|
listProjects | Read-only read | List workspace projects |
createProject | Changes data write | Create a project within plan limits |
getProject | Read-only read | Read a project's configuration and tracking state |
updateProject | Changes data write | Update project settings |
Project activation
#| Tool | Access | What it does |
|---|---|---|
activateProject | Changes data write generate | Activate project tracking with existing subscription checks |
Project analysis
#| Tool | Access | What it does |
|---|---|---|
startProjectAnalysis | Changes data write generate | Prepare and enqueue today's project analysis |
getProjectAnalysisStatus | Read-only read | Read truthful analysis and report readiness |
Brand research
#| Tool | Access | What it does |
|---|---|---|
enrichProject | Changes data write generate | Enrich a project using existing guarded provider behavior |
Model allocation
#| Tool | Access | What it does |
|---|---|---|
setProjectPromptAllocation | Changes data write | Set this project's share of the workspace prompt budget |
Brand profile
#| Tool | Access | What it does |
|---|---|---|
getBrandProfile | Read-only read | Read brand profile and writing guidance |
setBrandProfileField | Changes data write | Update one brand writing-guidance field |
Competitors
#| Tool | Access | What it does |
|---|---|---|
listCompetitors | Read-only read | List tracked competitors |
addCompetitor | Changes data write | Add a tracked competitor with existing duplicate checks |
replaceCompetitors | Changes data write | Atomically replace the curated competitor set |
removeCompetitor | Changes data write | Remove a tracked competitor |
suggestCompetitors | Changes data write generate | Discover competitor suggestions using stored project inputs and existing spend guards |
Tracked domains
#| Tool | Access | What it does |
|---|---|---|
listTrackedDomains | Read-only read | List the brand's owned domains |
addTrackedDomain | Changes data write | Track an owned domain with existing classification safeguards |
removeTrackedDomain | Changes data write | Stop treating a tracked domain as owned |
Topics
#| Tool | Access | What it does |
|---|---|---|
listTopics | Read-only read | List project topics |
createTopic | Changes data write | Create a project topic |
confirmProjectTopics | Changes data write | Atomically confirm onboarding topics |
renameTopic | Changes data write | Rename a project topic |
deleteTopic | Changes data write | Delete a project topic |
suggestTopics | Changes data write generate | Suggest topics grounded in the project's stored website and metadata |
acceptProjectTopics | Changes data write | Replace the project's accepted topic set including explicit tags |
Prompts
#| Tool | Access | What it does |
|---|---|---|
listPrompts | Read-only read | List project prompts and tracking state |
createPrompts | Changes data write | Add tracked prompts with plan caps and submission replay protection |
replaceProjectPrompts | Changes data write | Atomically replace and track the curated project prompt set |
generatePrompts | Changes data write generate | Generate proposed prompts and topics with existing spend guards |
suggestOnboardingPrompts | Changes data write generate | Generate reviewable onboarding prompts without accepting them |
acceptPrompt | Changes data write | Start tracking a proposed prompt within plan limits |
archivePrompt | Changes data write | Archive or restore a prompt using the existing lifecycle |
changePromptsInBulk | Changes data write | Track, archive, or restore a bounded prompt batch |
setPromptTopic | Changes data write | Assign a prompt to a topic in the same project |
deletePrompt | Changes data write | Permanently delete a prompt and its associated run history |
getPromptAnalysis | Read-only read | Read a prompt's measurement analysis |
Issues
#| Tool | Access | What it does |
|---|---|---|
getIssues | Read-only read | Read site audit findings and audit progress |
setIssueChecklistItem | Changes data write | Set an issue checklist item's completion state |
Website audits
#| Tool | Access | What it does |
|---|---|---|
enqueueAudit | Changes data write generate | Enqueue a guarded site audit without executing worker ticks |
listAudits | Read-only read | List audit history |
Opportunities
#| Tool | Access | What it does |
|---|---|---|
listOpportunities | Read-only read | Read current measured opportunities |
setOpportunityStatus | Changes data write | Mark an opportunity pending, done, or declined |
enqueueOpportunities | Changes data write generate | Enqueue guarded opportunity analysis without worker ticks |
Traffic
#| Tool | Access | What it does |
|---|---|---|
createTrafficAnnotation | Changes data write | Add a traffic chart annotation to the explicit project |
listTrafficAnnotations | Read-only read | List annotations for a bounded date window |
deleteTrafficAnnotation | Changes data write | Delete a traffic chart annotation from this project |
getGa4Traffic | Read-only read | Read Google Analytics traffic and receipt coverage |
getSearchConsoleTraffic | Read-only read | Read Search Console traffic and receipt coverage |
getGa4Breakdowns | Read-only read | Read GA4 pages, devices, acquisition and countries |
Integrations
#| Tool | Access | What it does |
|---|---|---|
listIntegrations | Read-only read | Read integration metadata and non-secret configuration |
getIntegrationSetupUrl | Read-only read integrations | Get a browser URL for interactive provider consent |
configureGoogleIntegration | Changes data write integrations | Configure a pending Google connection and atomically queue backfill |
configureWebflowIntegration | Changes data write integrations | Validate and configure an authorized Webflow collection |
disconnectIntegration | Changes data write integrations | Disconnect Google or revoke Webflow authorization safely |
listGoogleAnalyticsProperties | Read-only read integrations | List authorized Analytics properties without exposing credentials |
listGoogleSearchConsoleSites | Read-only read integrations | List authorized Search Console sites without credentials |
listWebflowSites | Read-only read integrations | List the authorized Webflow site |
listWebflowCollections | Read-only read integrations | List an authorized Webflow site's collections |
getWebflowCollection | Read-only read integrations | Read an authorized collection's fields and schema fingerprint |
Crawler sources
#| Tool | Access | What it does |
|---|---|---|
createCrawlerSource | Changes data write integrations | Create a crawler source and reveal its token once |
rotateCrawlerSource | Changes data write integrations | Rotate a crawler token with an expected-generation check; the previous token keeps working for 24 hours |
revokeCrawlerSource | Changes data write integrations | Revoke a crawler source with existing race protection |
Optimization proposals
#| Tool | Access | What it does |
|---|---|---|
listOptimizationProposals | Read-only read | Read retained optimization proposals and their frozen evidence |
createOptimizationProposal | Changes data write | Create a bounded proposal with frozen measurement evidence |
decideOptimizationProposal | Changes data write | Approve, reject, or revoke a proposal using existing version/hash guards |
Content Studio
#| Tool | Access | What it does |
|---|---|---|
listContent | Read-only read | List content projects with cursor pagination |
createContent | Changes data write | Create an Article or writer-brief project idempotently |
getContent | Read-only read | Read a content document and revision |
deleteContent | Changes data write | Delete a draft while preserving publication boundaries |
setContentStatus | Changes data write | Set draft, review or archived state |
setContentTags | Changes data write | Save tags against an expected document revision |
setContentTitle | Changes data write | Save a title against an expected document revision |
saveContentDocument | Changes data write | Save blocks and title against an expected revision |
saveContentBrief | Changes data write | Edit the writer brief against an expected brief revision |
getContentStudio | Read-only read | Read bounded Studio context, proposals, readiness and delivery state |
listContentMessages | Read-only read | Read the latest 100 content messages with truncation metadata |
getContentSetupQuestions | Changes data write | Create or replay deterministic content setup questions |
addContentSource | Changes data write | Verify and attach a public source idempotently |
removeContentSource | Changes data write | Remove a source from this content project |
decideContentProposal | Changes data write | Accept or reject a revision proposal |
listContentHistory | Read-only read | List 20 edit versions with a revision cursor |
getContentVersion | Read-only read | Preview a saved version of this document |
restoreContentVersion | Changes data write | Restore a saved version against an expected revision |
checkContentReadiness | Changes data write | Record readiness for the exact current document and sources |
generateContent | Changes data write generate | Queue idempotent initial generation or a scoped revision |
getContentGeneration | Read-only read | Poll a durable generation job and resulting proposal |
approveContent | Changes data write publish | Approve the exact current ready-to-publish version |
publishContent | Changes data write publish | Queue an approved version for Webflow draft or live delivery |
getContentPublishing | Read-only read | Read approval and paginated provider delivery status |
retryContentPublishing | Changes data write publish | Retry an eligible delivery while retaining approval safeguards |
AEO analytics
#| Tool | Access | What it does |
|---|---|---|
getAnalyticsOverview | Read-only read | Visibility per AI platform |
getAnalyticsVisibility | Read-only read | Visibility over time |
getAnalyticsVisibilityRanking | Read-only read | Competitor visibility ranking |
getAnalyticsVisibilityCompetitors | Read-only read | Competitor visibility over time |
getAnalyticsShareOfVoice | Read-only read | Share of voice by competitor |
getAnalyticsShareOfVoiceSeries | Read-only read | Share of voice over time |
getAnalyticsAveragePosition | Read-only read | Average mention position over time |
getAnalyticsPositionRanking | Read-only read | Average-position ranking |
getAnalyticsTopicRankings | Read-only read | Topic rankings and prompt positions |
getAnalyticsTopicBreakdown | Read-only read | Overview topic visibility and citation breakdown |
getAnalyticsTopicDistribution | Read-only read | Topic distribution |
getAnalyticsTopicPositions | Read-only read | Topic positions by engine |
getAnalyticsModels | Read-only read | AI platform comparison matrix |
getAnalyticsMetricSeries | Read-only read | Selected canonical metric by platform |
getAnalyticsMentions | Read-only read | Own-brand mention trend |
getAnalyticsCitations | Read-only read | Own-domain citation trend |
getAnalyticsSentiment | Read-only read | Sentiment over time |
getAnalyticsSentimentBreakdown | Read-only read | Sentiment scores and themes |
getAnalyticsSentimentStacked | Read-only read | Positive, neutral and negative sentiment over time |
getAnalyticsPerception | Read-only read | Latest Searchly brand-perception assessment |
getAnalyticsHeadToHead | Read-only read | Brand and competitor comparison |
getAnalyticsCitationShare | Read-only read | Citation share over time |
getAnalyticsCitationDomains | Read-only read | Citation domain ranking |
getAnalyticsCitationPages | Read-only read | Top cited pages |
getAnalyticsCitationTypes | Read-only read | Cited content-type breakdown |
getAnalyticsCitationDomainSeries | Read-only read | Citation-domain trends |
getAnalyticsCitedUrls | Read-only read | Cited URLs and source classifications |
getAnalyticsCitationGap | Read-only read | Competitor citation-domain gaps |
getAnalyticsContentTypeGap | Read-only read | Competitor content-type gaps |
getAnalyticsPositionDistribution | Read-only read | Mention-position distribution |
getAnalyticsFunnel | Read-only read | Decision-journey funnel breakdown |
getAnalyticsFanouts | Read-only read | Observed query fan-outs |
getAnalyticsSiteHealth | Read-only read | Site health and audit history |
getPromptAnalytics | Read-only read | Analyze one project prompt |
Answers
#| Tool | Access | What it does |
|---|---|---|
listAnswers | Read-only read | List raw observed answers with collection provenance |
getAnswer | Read-only read | Read an immutable answer capture and its provenance |
listAnswerCitations | Read-only read | Read parsed answer citations with pagination |
listAnswerMentions | Read-only read | Read parsed answer mentions with pagination |
Agent Analytics
#| Tool | Access | What it does |
|---|---|---|
listCrawlerSources | Read-only read | Read crawler connection state without credentials |
listCrawlerEvents | Read-only read | Read retained crawler events with bounded pagination |
getPageEvidence | Read-only read | Join observed answer citations, AI referrals and search traffic on one evidence day |
listPageRecords | Read-only read | Read Page Records with activity pagination and evidence coverage |
getPageRecord | Read-only read | Read a Page Record for a precise project URL |
getPageRechecks | Read-only read | Read bounded active, completed and failed rechecks |
AI shopping
#| Tool | Access | What it does |
|---|---|---|
getShoppingReport | Read-only read | Read the AI shopping report for a date window |
getShoppingPromptEvidence | Read-only read | Read the product shelves ChatGPT showed for one prompt |
getShoppingProductEvidence | Read-only read | Read every appearance of one product in ChatGPT answers |