prompts

Edit a prompt

A change to text or intent creates a new version under the same promptGroupId (new promptId, version incremented); runs already executed keep pointing at the version that produced them. tags, active and page change in place, and a new version keeps the page. Reactivating counts as a creation against the plan limit.

page names the page on the brand's own site that should answer the question. Findings about it name that page from the next measurement; with none set and none of the brand's pages cited, a finding names no page (recommendation.target null). null clears it.

Request body

textstring

intent'informational' | 'comparison' | 'commercial' | 'navigational' | 'problem'

Why someone would ask the prompt. informational — learning about a topic. comparison — weighing named options. commercial — choosing what to buy. navigational — looking for a specific site or brand. problem — fixing something. The intent decides which diagnostic rules apply to the prompt's results.

tagsstring[]

activeboolean

pagestring nullable

The page on the brand's own site that should answer this question. Null clears it.

Response

The current version.

promptGroupIdstring required

Stable across edits. Use it for trends and for PATCH/DELETE.

promptIdstring required

The current version's id. Changes when text or intent is edited.

textstring required

intent'informational' | 'comparison' | 'commercial' | 'navigational' | 'problem' required

Why someone would ask the prompt. informational — learning about a topic. comparison — weighing named options. commercial — choosing what to buy. navigational — looking for a specific site or brand. problem — fixing something. The intent decides which diagnostic rules apply to the prompt's results.

tagsstring[] required

activeboolean required

createdAtstring date-time required

versioninteger required

pagestring nullable required

The page on the brand's own site that should answer this question, set by a person. Findings about it name this page. Null when none is set.