Skip to main content
GET
Get SEO Guidelines

Authorizations

API-KEY
string
header
required

Path Parameters

workspace_id
integer
required
Required range: x >= 1
Example:

123

content_editor_id
integer
required
Required range: x >= 1
Example:

123

Response

SEO Guidelines

inserted_at
string<date-time>
required
Example:

"2024-04-12T15:23:45Z"

can_load_more_competitors
boolean
required
Example:

true

competitors
SeoGuidelinesCompetitor · object[]
required
id
integer
required
Required range: x >= 1
Example:

123

load_more_status
enum<string>
required
Available options:
executing,
idle
Example:

"idle"

score
integer | null
required
Required range: 0 <= x <= 100
Example:

78

status
enum<string>
required
Available options:
completed,
executing,
failed,
scheduled
Example:

"completed"

structure
SeoGuidelinesStructureResponse · object
required
Example:
terms
SeoGuidelinesTerm · object[]
required
topics_and_questions
SeoGuidelinesTopic · object[]
required
updated_at
string<date-time>
Example:

"2024-06-01T09:17:33Z"