web_analytics
aeo_prompts

Turn an AEO prompt on or off

Changed on
patch/api/projects/{project_id}/aeo_prompts/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/aeo_prompts/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required
project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

activeboolean

Turn the prompt on or off for future runs.

Response

idstring required

Prompt id.

promptstring required

The question asked to the answer engines, as a user would phrase it.

topicstring required

Theme the prompt belongs to. The runner alternates between topics on each run.

prompt_sourcestring required

Where the prompt came from: 'imported' or 'manual'.

ranknumber double required

Seeding score. Within a topic, higher runs first.

activeboolean required

Only active prompts are run against the answer engines.

last_checked_atstring date-time nullable required

When the runner last ran this prompt. Null when it never ran.

external_visibilitynumber double nullable required

Share of answers (0-100) that mention the brand for this prompt, as reported by the tool the prompt set came from. Kept to benchmark against our own citation rate. Null when the import carried none.

created_atstring date-time required

When the prompt was added.

updated_atstring date-time nullable required

When the prompt last changed.

Changes