Skip to main content
GET
Get Prompt

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required
prompt_uid
string<uuid>
required

Query Parameters

engine
enum<string> | null
Available options:
perplexity,
gemini,
openai,
google_aio,
ai_mode,
copilot,
claude
prompt
string<uuid> | null
type
enum<string> | null
Available options:
organic,
brand_specific,
competitor_comparison
intent
enum<string> | null
Available options:
educational,
problem,
comparison,
transactional
topic
string<uuid> | null
segment
string | null
as_of
string<uuid> | null

Include only scans up to this completed scan id.

period
enum<string>
default:1w
Available options:
1w,
4w,
12w,
all

Response

Successful Response

actions
V1PromptAction · object[]
required
answers
integer
default:0
required
competitors
V1PromptCompetitor · object[]
required
engine_cards
PromptEngineCard · object[]
required
engine_note
string | null
required
engine_vocabulary
EngineVocabulary · object[]
required
engines
V1PromptLatestEngine · object[]
required
id
string<uuid>
required
intent
string | null
required
intent_source
enum<string>
default:heralded
required
Available options:
member,
heralded
measurement
KeywordMeasurement · object | null
required
meta
Meta · object
required

Normalized query and newest included scan.

period
V1Period · object
required
prompt_type
string | null
required
prompt_type_source
enum<string>
default:heralded
required
Available options:
member,
heralded
retention_days
integer | null
required
score
V1Figure · object
required
search_volume
integer | null
required
segment
string
required
segment_detail
PromptSegment · object | null
required
sentence
string | null
required
sources
V1PromptSource · object[]
required
status
enum<string>
required
Available options:
active,
paused,
archived
status_since
string<date-time> | null
required
tail_note
string | null
required
text
string
required
third_report_due_at
string<date-time> | null
required
tiles
PromptTile · object[]
required
topic
string | null
required
topic_id
string | null
required
tracked_since
string<date-time> | null
required