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

The brand's UUID from listBrands.

prompt_uid
string<uuid>
required

The prompt id from list_prompts.

Query Parameters

country
string | null

Check country or global. Omit for all.

with_details
boolean
default:true

Include engine cards and paged Google searches.

with_engine_cards
boolean
default:true

Include engine cards with details.

with_searches
boolean
default:true

Include Google searches with details.

wordings_limit
integer | null

Current markets to return; the compact read defaults to five.

Required range: 1 <= x <= 100
wordings_offset
integer
default:0

Current markets to skip.

Required range: x >= 0
wordings_language
string | null

Language code of current markets.

searches_limit
integer | null

Google searches to return; omitted returns all.

Required range: 1 <= x <= 100
searches_offset
integer
default:0

Google searches to skip.

Required range: x >= 0
sources_limit
integer
default:5

Cited sites per page.

Required range: 1 <= x <= 100
sources_offset
integer
default:0

Cited sites to skip.

Required range: x >= 0
competitors_limit
integer | null

Brands per page.

Required range: 1 <= x <= 100
competitors_offset
integer
default:0

Brands to skip.

Required range: x >= 0
market
string | null

Country ISO code, europe for pooled Europe, or global for no country. Omit for all.

audience

Audience UUID, or all_buyers for topics for all buyers. Omit for all.

engine
enum<string> | null

Answering AI engine.

Available options:
perplexity,
gemini,
openai,
google_aio,
ai_mode,
copilot,
claude
type
enum<string> | null

Question type.

Available options:
organic,
brand_specific,
competitor_comparison
intent
enum<string> | null

Question intent.

Available options:
educational,
problem,
comparison,
transactional
topic
string<uuid> | null

Tracked topic UUID.

prompt
string<uuid> | null

Question id from list_prompts.

as_of
string<uuid> | null

Completed scan id cutoff.

period
enum<string>
default:1w

Weekly-report period.

Available options:
1w,
4w,
12w,
all

Response

Successful Response

actions
V1PromptAction · object[]
required

The first three live actions about this prompt, highest priority first.

actions_total
integer
default:0
required

Every live action about this subject, before the list is cut.

ai_searches
V1AISearch · object[]
required

Observed engine searches tied to this prompt's dated answers. Leads for Google-rank checks, never buyer evidence or page-coverage questions. Empty when no retained answer exposes searches.

answers
integer
default:0
required
competitors
V1PromptCompetitor · object[]
required
competitors_total
integer
required

The prompt-filtered Competitors board's total.

engine_cards
PromptEngineCard · object[]
required
engine_vocabulary
EngineVocabulary · object[]
required
engines
V1PromptLatestEngine · object[]
required
evidence
V1TopicEvidence · object[]
required

The stored evidence behind the prompt: the buyer phrasing it was drafted from, then the questions members added to its topic, which feed the topic's next draft. Empty when nothing was recorded.

figures
V1SideFigures · object | null
required

The question's figures with their weekly trends and changes.

first_answers_at
string<date-time> | null
required

The first answered time, or the estimate while its prompt read is pending. Null when no estimate is available.

first_score_on
string<date> | null
required

The next weekly report's date for the market. Null before the brand has a weekly schedule.

google_searches
V1PromptGoogleSearch · object[]
required

The Google searches the engines ran for this prompt, one entry for each text and market, whatever the number of engines and days that ran it. Most searched first: monthly searches with unknown volumes last, then ranked before unranked by position, then A to Z. Paged with searches_limit and searches_offset when with_details is true. Empty when no retained answer exposes searches.

google_searches_total
integer | null
required

Google searches before paging; null when details were not requested.

health
PromptHealth · object | null
required

How often an active prompt's answers name any company, by week. Null until a week is measured.

id
string<uuid>
required
insight
ServedInsight · object | null
required

Where an engine's latest answer leaves you out: the piece that fits the question and the content work filed for it.

intent
string | null
required
intent_source
enum<string>
default:heralded
required
Available options:
member,
heralded
languages
string[]
required
markets_by_language
Markets By Language · object
required

Current markets in each language before filtering.

markets_total
integer
default:0
required

Current country and language markets.

master_version
integer | null
required
measurement
KeywordMeasurement · object | null
required
measurement_status
enum<string>
default:new
required

New until a subscription weekly report scores it, then measured. Independent of tracking state.

Available options:
new,
measured
meta
Meta · object
required

Normalized query and newest included scan.

next_step
V1PromptAction · object | null
required

The action next_step_action_id names, in the same shape as actions.

next_step_action_id
string<uuid> | null
required

The highest-priority live action that awaits a member and whose verb the reader may press; null when there is none.

period
V1Period · object
required
product_cards
ProductCardsCell · object | null
required

Product-card figures for ecommerce brands; null for other brands and Google search.

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
sources
V1PromptSource · object[]
required
sources_total
integer
default:0
required

The distinct domains the prompt's answers in the period cite, of which sources lists the five cited most.

status
enum<string>
required
Available options:
active,
paused,
archived
status_since
string<date-time> | null
required
synthesised
boolean | null
required

True when Heralded wrote the prompt with no buyer evidence behind it; null when it was written before drafts recorded their evidence, or by a member.

text
string
required
third_report_due_at
string<date-time> | null
required
tiles
PromptTile · object[]
required
topic
string | null
required
topic_detail
V1PromptTopic · object | null
required

The topic the prompt belongs to.

tracked_since
string<date-time> | null
required
wordings
V1PromptWording · object[]
required

Compact reads return current market wordings, most answers first, five by default. With details and no wordings_limit, includes wording history.