Skip to main content
GET
Get prompt detail

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard under Settings > API keys.

Path Parameters

prompt_id
integer
required

Query Parameters

answers_limit
integer
default:5
Required range: 1 <= x <= 20
website_id
integer
required

Target website id

Response

Successful Response

id
integer
required
content
string
required
status
enum<string>
required
Available options:
winning,
at_risk,
losing,
unclaimed
visibility
number
required
coverage_cited
integer
required
coverage_total
integer
required
topic_id
integer | null
topic_name
string | null
tags
TagOnPromptSchema · object[]
intent
enum<string> | null
Available options:
informational,
comparative,
transactional,
navigational
journey_stage
enum<string> | null
Available options:
discovery,
consideration,
decision,
retention
brand_scope
enum<string> | null
Available options:
branded,
non_branded
brand_scope_manual
boolean
default:false
localizations
string[]
visibility_delta_7d
number | null
answer_count
integer
default:0
avg_position
number | null
avg_position_delta
number | null
best_rank
integer | null
best_rank_platform
enum<string> | null
Available options:
ChatGPT,
Gemini,
AI Overviews,
Google AI Mode,
Perplexity,
Mistral,
Claude,
DeepSeek,
Grok,
Copilot,
Bing AI Mode
ai_search_volume
integer | null
ai_volume_delta
number | null
volume_trend
PromptVolumeTrendPointSchema · object[]
visibility_30d
PromptVisibilityPointSchema · object[]
per_platform
PromptPlatformDetailSchema · object[]
latest_answers
PromptLatestAnswerSchema · object[]