Docs Sign inGet started
API reference · Prompts

Get a prompt

One prompt: metrics, brands, sources, latest answers.

GET/api/v1/domains/{domain}/prompts/{prompt_id}

Path parameters

domainstringRequired

The domain's host, like acme.example, or its ID. List them with List domains.

prompt_idstringRequired

A prompt's id, from List prompts.

Query parameters

rangestringdefault 30d

How far back to count: 7d, 30d, 90d or all. The previous period is the same length, just before.

7d30d90dall
surfacestring

Limit to one surface, written engine:lane, e.g. chatgpt_app:chat.

topicstring

Limit to prompts in one topic (exact name).

brandedstringdefault unbranded

Whether to count prompts that name your brand: unbranded (default), all or branded.

unbrandedallbranded

Returns

promptstring

The question.

kpisobject

The same headline numbers as Get metrics, for this prompt.

brandsarray

Brands named in its answers, with visibility.

surfacesarray

Per surface: visibility, change, citations and position.

sourcesarray

The ten sites cited most, with their top URLs.

latest_answersarray

Every answer from the latest run.

Every response includes the domain and the filters that were applied. Errors use the standard error object.