Console API

SEO

6 endpoints.

GET/api/v1/admin/businesses/{business_id}/seo/actions

The site's prioritized SEO action list

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`status`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_ActionsData_

Field Type Description

request_idrequired string

success true default true

datarequired

ActionsData

ActionsData fields

Field	Type	Description
`businessId`required	`string (uuid)`
`websiteId`required	`string (uuid)`
`actions`required	`ActionItem[]`	ActionItem[] fields ActionItem (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/seo/blog/overview

Blog overview: search totals across every post, tracked keywords, per-post views

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BlogOverviewData_

Field Type Description

request_idrequired string

success true default true

datarequired

BlogOverviewData

BlogOverviewData fields

Field Type Description

businessIdrequired string (uuid)

websiteIdrequired string (uuid)

generatedAtrequired string (date-time)

windowrequired

Window

Window fields

Field	Type	Description
`current`required	`DateRange`	DateRange fields DateRange (not expanded)
`previous`required	`DateRange`	DateRange fields DateRange (not expanded)

totalsrequired

BlogTotals

BlogTotals fields

Field	Type	Description
`impressions`required	`KpiTile`	KpiTile fields KpiTile (not expanded)
`clicks`required	`KpiTile`	KpiTile fields KpiTile (not expanded)

keywordsrequired

BlogKeywordRow[]

BlogKeywordRow[] fields

BlogKeywordRow (not expanded)

postsrequired

object

object fields

Map of string to PostViews

PostViews (not expanded)

coveragerequired

Coverage

Coverage fields

Field	Type	Description
`gscThrough`	`string (date) \| null`
`posthogThrough`	`string (date) \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/seo/blog/posts/{blog_post_id}

Per-post performance: traffic, search, audit, speed and quality, with 30-day changes

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`blog_post_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BlogPostPerformanceData_

Field Type Description

request_idrequired string

success true default true

datarequired

BlogPostPerformanceData

BlogPostPerformanceData fields

Field	Type	Description
`blogPostId`required	`string (uuid)`
`businessId`required	`string (uuid)`
`websiteId`required	`string (uuid)`
`slug`required	`string`
`path`required	`string`
`publishedOn`	`string (date) \| null`
`generatedAt`required	`string (date-time)`
`window`required	`Window`	Window fields Window, expanded above.
`isNew`required	`boolean`
`sections`required	`PerfSection[]`	PerfSection[] fields PerfSection (not expanded)
`queries`required	`DrivingQuery[]`	DrivingQuery[] fields DrivingQuery (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/seo/scores

Current SEO scores per category, with history

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_ScoresData_

Field Type Description

request_idrequired string

success true default true

datarequired

ScoresData

ScoresData fields

Field	Type	Description
`businessId`required	`string (uuid)`
`websiteId`required	`string (uuid)`
`generatedAt`required	`string (date-time)`
`scores`required	`CategoryScore[]`	CategoryScore[] fields CategoryScore (not expanded)
`history`required	`object`	object fields Map of string to ScoreHistoryPoint[] Nested object (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/seo/site-health

Site health: technical audit, content review, traffic and search, latest vs previous

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_SiteHealthData_

Field Type Description

request_idrequired string

success true default true

datarequired

SiteHealthData

SiteHealthData fields

Field Type Description

businessIdrequired string (uuid)

websiteIdrequired string (uuid)

domainrequired string

generatedAtrequired string (date-time)

build

BuildBlock | null

BuildBlock fields

Field	Type	Description
`latest`required	`BuildSnapshot`	BuildSnapshot fields BuildSnapshot (not expanded)
`previous`	`BuildSnapshot \| null`	BuildSnapshot fields BuildSnapshot (not expanded)

reads

ReadsBlock | null

ReadsBlock fields

Field	Type	Description
`latest`required	`QualitySnapshot`	QualitySnapshot fields QualitySnapshot (not expanded)
`previous`	`QualitySnapshot \| null`	QualitySnapshot fields QualitySnapshot (not expanded)
`targetQueryCount`required	`integer`

traffic

TrafficBlock | null

TrafficBlock fields

Field	Type	Description
`current`required	`TrafficWindow`	TrafficWindow fields TrafficWindow (not expanded)
`previous`required	`TrafficWindow`	TrafficWindow fields TrafficWindow (not expanded)
`organicCurrent`required	`TrafficWindow`	TrafficWindow fields TrafficWindow (not expanded)
`organicPrevious`required	`TrafficWindow`	TrafficWindow fields TrafficWindow (not expanded)
`byDevice`required	`DeviceTraffic[]`	DeviceTraffic[] fields Nested object (not expanded)
`byDevicePrevious`required	`DeviceTraffic[]`	DeviceTraffic[] fields Nested object (not expanded)
`visitorsSeries`required	`SeriesPoint[]`	SeriesPoint[] fields Nested object (not expanded)
`weeklyActive`	`WeeklyActive \| null`	WeeklyActive fields WeeklyActive (not expanded)
`byPageType`	`PageTypeShare[]`	default [] PageTypeShare[] fields Nested object (not expanded)
`byPageTypePrevious`	`PageTypeShare[]`	default [] PageTypeShare[] fields Nested object (not expanded)

conversions

ConversionsBlock | null

ConversionsBlock fields

Field	Type	Description
`current`required	`ConversionCount[]`	ConversionCount[] fields Nested object (not expanded)
`previous`required	`ConversionCount[]`	ConversionCount[] fields Nested object (not expanded)
`organicCurrent`	`ConversionCount[]`	default [] ConversionCount[] fields Nested object (not expanded)
`organicPrevious`	`ConversionCount[]`	default [] ConversionCount[] fields Nested object (not expanded)

search

SearchBlock | null

SearchBlock fields

Field	Type	Description
`current`required	`SearchWindow`	SearchWindow fields SearchWindow (not expanded)
`previous`required	`SearchWindow`	SearchWindow fields SearchWindow (not expanded)
`bySearchType`required	`SearchSlice[]`	SearchSlice[] fields Nested object (not expanded)
`byDevice`required	`SearchSlice[]`	SearchSlice[] fields Nested object (not expanded)
`byCountry`required	`SearchSlice[]`	SearchSlice[] fields Nested object (not expanded)
`byAppearance`required	`SearchSlice[]`	SearchSlice[] fields Nested object (not expanded)
`byDevicePrevious`required	`SearchSlice[]`	SearchSlice[] fields Nested object (not expanded)
`byAppearancePrevious`required	`SearchSlice[]`	SearchSlice[] fields Nested object (not expanded)

issuesTrendrequired

IssueTrendPoint[]

IssueTrendPoint[] fields

IssueTrendPoint (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/seo/portfolio

Every site's current overall score — worst first

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PortfolioData_

Field Type Description

request_idrequired string

success true default true

datarequired

PortfolioData

PortfolioData fields

Field	Type	Description
`entries`required	`PortfolioEntry[]`	PortfolioEntry[] fields PortfolioEntry (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.