Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

whoami

account.whoami Get the connected OpenSEO account, token scopes and remaining credits Risk: read
Input: empty object Output

Ai Visibility

completeResearchSetup

aiVisibility.completeResearchSetup Set up Prompt Research keywords for a project (can turn on weekly paid AI checks) Risk: destructive
Input Output

estimateCost

aiVisibility.estimateCost Estimate the cost of AI visibility checks without running them Risk: read
Input
Output

explorePrompt

aiVisibility.explorePrompt Ask a prompt in ChatGPT, Claude, Gemini or Perplexity and see answers, citations and brand mentions Risk: destructive
Input Output

export

aiVisibility.export Export stored AI visibility observations as a CSV or JSON download link Risk: read
Input Output

generatePrompts

aiVisibility.generatePrompts Generate topic and prompt suggestions for AI visibility tracking Risk: destructive
Input Output

getAnswer

aiVisibility.getAnswer Get one stored AI answer with its prompt, mentions and citations Risk: read
Input Output

getResults

aiVisibility.getResults Get how often the brand and competitors appear in AI answers for a run Risk: read
Input Output

getRun

aiVisibility.getRun Get the progress of an AI visibility check Risk: read
Input Output

getSources

aiVisibility.getSources List the pages or domains AI answers cited in a run Risk: read
Input Output

getTracker

aiVisibility.getTracker Get a project’s AI visibility tracking setup: topics, prompts, engines and schedule Risk: read
Input Output

getTrend

aiVisibility.getTrend Compare recent AI visibility with the previous period Risk: read
Input Output

researchPrompts

aiVisibility.researchPrompts Find questions people ask AI about a keyword, with ChatGPT’s answers and sources Risk: read
Input Output

runCheck

aiVisibility.runCheck Start a one-off paid AI visibility check now Risk: destructive
Input Output

saveTracker

aiVisibility.saveTracker Create or update AI visibility tracking prompts, topics, engines and market Risk: write
Input
Output

setSchedule

aiVisibility.setSchedule Turn scheduled AI visibility checks on, change the cadence or pause them Risk: destructive
Input
Output

updateResearchKeywords

aiVisibility.updateResearchKeywords Add or remove a project’s saved Prompt Research keywords Risk: write
Input Output

list

backlinks.list List a domain’s or page’s individual backlinks with anchors and authority, paginated Risk: read
Input
Output

overview

backlinks.overview Summarize a domain’s or page’s backlinks, referring domains and authority Risk: read
Input Output

Domains

keywords

domains.keywords List the organic keywords a domain ranks for, with position and metrics Risk: read
Input Output

overview

domains.overview Estimate a domain’s monthly organic traffic and ranking keyword count Risk: read
Input Output

rankedKeywords

domains.rankedKeywords List the keywords a domain or page ranks for in one country, with ranking URL and traffic Risk: read
Input
Output

Google Analytics

audienceBreakdown

googleAnalytics.audienceBreakdown Break down visitors by device, country or new versus returning Risk: read
Input Output

ecommercePerformance

googleAnalytics.ecommercePerformance Get GA4 ecommerce item views, add-to-carts, purchases and revenue Risk: read
Input Output

keyEvents

googleAnalytics.keyEvents Get GA4 key events (conversions) by event or organic landing page Risk: read
Input Output

listProperties

googleAnalytics.listProperties List the GA4 properties of the connected Google accounts Risk: read
Input Output

measurementHealth

googleAnalytics.measurementHealth Check how Google Analytics is set up on the connected property Risk: read
Input Output

organicLandingPages

googleAnalytics.organicLandingPages Get the landing pages that receive organic search traffic Risk: read
Input Output

organicOverview

googleAnalytics.organicOverview Get top-line organic search sessions, users and key events with a trend Risk: read
Input Output

pagePerformance

googleAnalytics.pagePerformance Get page views, users, engagement and key events per page Risk: read
Input Output

setProperty

googleAnalytics.setProperty Set which GA4 property a project reads Risk: write
Input Output

siteSearch

googleAnalytics.siteSearch Get the terms visitors search for on the site Risk: read
Input Output

trafficAcquisition

googleAnalytics.trafficAcquisition Compare traffic by channel group, source/medium or campaign Risk: read
Input Output

Index Now

submitUrls

indexNow.submitUrls Notify IndexNow search engines (Bing, Yandex and others) that pages changed Risk: destructive · Irreversible
Input Output

Keywords

listSaved

keywords.listSaved List a project’s saved keywords with cached volume, difficulty, CPC and tags Risk: read
Input Output

metrics

keywords.metrics Get search volume, difficulty, intent, CPC and trends for a list of keywords Risk: read
Input Output

removeSaved

keywords.removeSaved Delete saved keywords from a project by ID Risk: destructive · Irreversible
Input Output

research

keywords.research Find keyword ideas for 1-5 seed keywords with volume, difficulty, CPC and intent Risk: read
Input
Output

save

keywords.save Save keywords to a project, optionally with metrics and tags Risk: write
Input
Output

suggestions

keywords.suggestions Suggest up to 10 seed keywords to research next from Search Console and saved keywords Risk: read
Input Output

Local

businessProfile

local.businessProfile Get a Google Business Profile by name, CID or place ID Risk: read
Input
Output

businessQuestions

local.businessQuestions Get the questions and answers on a Google Business Profile Risk: read
Input
Output

businessReviews

local.businessReviews Get a business’s Google reviews with ratings and owner replies Risk: read
Input
Output

businessUpdates

local.businessUpdates Get the posts published on a Google Business Profile Risk: read
Input
Output

listCategories

local.listCategories List Google Business categories ranked by how many businesses use them Risk: read
Input Output

rankGrid

local.rankGrid Map a business’s Google Maps rank across a grid of points around a center Risk: read
Input
Output

searchBusinesses

local.searchBusinesses Search local business listings near a coordinate Risk: read
Input
Output

serpResults

local.serpResults Get Google Maps or Local Finder results for a keyword from a coordinate Risk: read
Input
Output

Projects

create

projects.create Create a project with a name and optional domain and market Risk: write
Input Output

getContext

projects.getContext Get a project’s shared memory: overview, goal, positioning, competitors and key pages Risk: read
Input Output

list

projects.list List projects with their ID, name, domain and default market Risk: read
Input: empty object Output

researchWebsite

projects.researchWebsite Research a project’s website to draft its brand, overview, competitors and prompt topics Risk: destructive
Input Output

saveWebsiteSetup

projects.saveWebsiteSetup Save a drafted website setup (brand, overview, competitors, topics) to a project Risk: write
Input
Output

updateContext

projects.updateContext Add, edit or delete entries in a project’s shared memory Risk: write
Input
Output

Rank Tracking

addKeywords

rankTracking.addKeywords Add keywords to a rank tracker Risk: write
Input Output

create

rankTracking.create Create a rank tracker for a project Risk: write
Input
Output

estimateCost

rankTracking.estimateCost Estimate what a rank check costs without running it Risk: read
Input Output

get

rankTracking.get List a project’s rank trackers or get one with its latest Google positions Risk: read
Input Output

history

rankTracking.history Get the position history of a rank tracker’s keywords Risk: read
Input Output

pinKeywords

rankTracking.pinKeywords Pin or unpin tracked keywords Risk: write
Input Output

removeKeywords

rankTracking.removeKeywords Stop tracking keywords in a rank tracker Risk: destructive · Irreversible
Input Output

run

rankTracking.run Start a paid rank check now for every keyword in a tracker Risk: destructive
Input Output

Reports

delete

reports.delete Delete a saved report and its shared link Risk: destructive · Irreversible
Input Output

deleteTemplate

reports.deleteTemplate Delete a report template Risk: destructive · Irreversible
Input Output

get

reports.get Get a saved report with its summary and share link Risk: read
Input Output

list

reports.list List a project’s saved reports Risk: read
Input Output

listTemplates

reports.listTemplates List a project’s report templates Risk: read
Input Output

save

reports.save Save an HTML report to a project Risk: write
Input Output

saveTemplate

reports.saveTemplate Save a reusable report template to a project Risk: write
Input Output

setSharing

reports.setSharing Turn public sharing of a saved report on or off Risk: destructive
Input Output

Search Console

inspectUrls

searchConsole.inspectUrls Check whether Google has indexed up to 10 pages, and why not Risk: read
Input Output

listSites

searchConsole.listSites List the Search Console properties of the connected Google accounts Risk: read
Input Output

opportunities

searchConsole.opportunities Find pages ranking 4-20 in Search Console that are most worth improving Risk: read
Input Output

performance

searchConsole.performance Get Search Console clicks, impressions, CTR and position by query, page or other dimension Risk: read
Input
Output

setSite

searchConsole.setSite Set which Search Console property a project reads Risk: write
Input Output

Serp

competitors

serp.competitors Find the domains that compete in Google results for a set of keywords Risk: read
Input
Output

results

serp.results Get live Google organic results for 1-10 keywords Risk: read
Input
Output

searchLocations

serp.searchLocations Find the exact location name of a city or region for local searches Risk: read
Input Output

Site Audits

delete

siteAudits.delete Delete a site audit with its pages, issues and Lighthouse results Risk: destructive · Irreversible
Input Output

issues

siteAudits.issues Get the prioritized issues from a completed site audit Risk: read
Input Output

lighthouse

siteAudits.lighthouse Get the Lighthouse results from a site audit Risk: read
Input Output

list

siteAudits.list List a project’s site audits with status and page counts Risk: read
Input Output

pages

siteAudits.pages List the pages a site audit crawled with per-page SEO data Risk: read
Input Output

run

siteAudits.run Start a background site audit (crawl, SEO checks, optional Lighthouse) Risk: write
Input Output

status

siteAudits.status Get the progress of a site audit Risk: read
Input Output