SeoApi
Defined in: packages/sdk/src/resources/SeoApi.ts:21
The SEO/GEO surface — tier management, on-demand scans, GEO probes, AI helpers (alt-text, meta-description, blog draft, local page), competitor + citation editors, manual cron trigger, and Google Search Console OAuth.
Extends
Section titled “Extends”Resource
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SeoApi(
opts):SeoApi
Defined in: packages/sdk/src/request.ts:93
Parameters
Section titled “Parameters”Returns
Section titled “Returns”SeoApi
Inherited from
Section titled “Inherited from”Resource.constructor
Methods
Section titled “Methods”altText()
Section titled “altText()”altText(
websiteId,input):Promise<{limit:number;suggestion:string;used:number; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:61
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
context?
Section titled “context?”string
imageDescription
Section titled “imageDescription”string
Returns
Section titled “Returns”Promise<{ limit: number; suggestion: string; used: number; }>
blogDraft()
Section titled “blogDraft()”blogDraft(
websiteId,input):Promise<{limit:number;markdown:string;used:number; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:77
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
audience?
Section titled “audience?”string
lengthWords?
Section titled “lengthWords?”number
string
Returns
Section titled “Returns”Promise<{ limit: number; markdown: string; used: number; }>
contentAudit()
Section titled “contentAudit()”contentAudit(
websiteId,input):Promise<{cached:boolean;cachedAt?:string;findings:SeoContentAuditFinding[];limit:number;overallScore:number;used:number; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:95
Audit the website’s CMS content document and return a structured
8-dimension rubric report. Growth+ only. Content-hashed cache: a
repeat call with the same siteContent returns the cached result
with cached: true and does NOT consume a quota slot.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
siteContent
Section titled “siteContent”Record<string, unknown>
Returns
Section titled “Returns”Promise<{ cached: boolean; cachedAt?: string; findings: SeoContentAuditFinding[]; limit: number; overallScore: number; used: number; }>
disable()
Section titled “disable()”disable(
websiteId):Promise<{website:Website; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:44
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ website: Website; }>
geoProbe()
Section titled “geoProbe()”geoProbe(
websiteId,input):Promise<{limit:number;primaryHost:string|null;run:GeoProbeRun;used:number; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:50
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
model?
Section titled “model?”string
prompt
Section titled “prompt”string
Returns
Section titled “Returns”Promise<{ limit: number; primaryHost: string | null; run: GeoProbeRun; used: number; }>
get(
websiteId):Promise<SeoStatusResponse>
Defined in: packages/sdk/src/resources/SeoApi.ts:31
Read current tier + capability snapshot + every cached datum the
SEO panel renders. Return shape is the canonical
SeoStatusResponse from @vantageconnections/shared — bundles
enabled, tier, capabilities, lastScan, geoProbes,
citations, competitorUrls, competitorSnapshots,
competitorDiffs, gscMetrics, gsc (connection state), and
aiUsage (running monthly quota counters).
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<SeoStatusResponse>
getCitations()
Section titled “getCitations()”getCitations(
websiteId):Promise<{citations:CitationEntry[]; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:127
Read just the citations checklist (subset of get() if that’s all you need).
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ citations: CitationEntry[]; }>
gscConnect()
Section titled “gscConnect()”gscConnect(
websiteId):Promise<{authUrl:string; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:149
Begin a Google Search Console OAuth flow for the website. The
returned authUrl opens Google’s consent screen; once the client
approves, Google redirects back to /oauth/google/callback and the
token is stored. Until that round-trip completes, GSC pulls are
skipped.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ authUrl: string; }>
gscDisconnect()
Section titled “gscDisconnect()”gscDisconnect(
websiteId):Promise<{disconnected:true; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:157
Drop the stored GSC token + clear cached metrics.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ disconnected: true; }>
gscRefresh()
Section titled “gscRefresh()”gscRefresh(
websiteId):Promise<{metrics:GscMetricsSummary; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:153
Force an immediate Search Console metrics pull.
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ metrics: GscMetricsSummary; }>
localPage()
Section titled “localPage()”localPage(
websiteId,input):Promise<{limit:number;markdown:string;used:number; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:83
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
businessSummary?
Section titled “businessSummary?”string
string
focusService?
Section titled “focusService?”string
Returns
Section titled “Returns”Promise<{ limit: number; markdown: string; used: number; }>
metaDescription()
Section titled “metaDescription()”metaDescription(
websiteId,input):Promise<{limit:number;suggestion:string;used:number; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:67
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
pageBodyExcerpt?
Section titled “pageBodyExcerpt?”string
pagePath?
Section titled “pagePath?”string
pageTitle
Section titled “pageTitle”string
Returns
Section titled “Returns”Promise<{ limit: number; suggestion: string; used: number; }>
runCron()
Section titled “runCron()”runCron(
websiteId,opts?):Promise<{report:unknown; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:135
Trigger the same tier-cadence work the 6-hour SEO cron does, on
demand for a single site. Pass force: true to bypass cadence
gating (essentials = monthly, growth = weekly, premium+ = daily).
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
force?
Section titled “force?”boolean
Returns
Section titled “Returns”Promise<{ report: unknown; }>
scan()
Section titled “scan()”scan(
websiteId):Promise<{scan:SeoScanResult; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:47
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
Returns
Section titled “Returns”Promise<{ scan: SeoScanResult; }>
setCitations()
Section titled “setCitations()”setCitations(
websiteId,citations):Promise<{citations:CitationEntry[]; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:118
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
citations
Section titled “citations”CitationEntry[]
Returns
Section titled “Returns”Promise<{ citations: CitationEntry[]; }>
setCompetitors()
Section titled “setCompetitors()”setCompetitors(
websiteId,urls):Promise<{competitorUrls:string[]; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:112
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
string[]
Returns
Section titled “Returns”Promise<{ competitorUrls: string[]; }>
setTier()
Section titled “setTier()”setTier(
websiteId,tier):Promise<{capabilities:SeoCapabilities;tier:SeoTier;website:Website; }>
Defined in: packages/sdk/src/resources/SeoApi.ts:34
Parameters
Section titled “Parameters”websiteId
Section titled “websiteId”string
SeoTier
Returns
Section titled “Returns”Promise<{ capabilities: SeoCapabilities; tier: SeoTier; website: Website; }>