v1

latestOpenAPI 3.0.12026-07-1361339.6 KB

Basic

Retrieve prompt

Retrieve detailed information about a specific prompt, including its visibility settings, using the prompt's unique identifier. This endpoint is useful for obtaining insights into a prompt's configuration and its associated data within the specified date range.

get/marketing/aeo/2026-09-beta/prompts/{promptId}

Path parameters

promptIdstring required

The unique identifier of the prompt to retrieve.

Query parameters

endDatestring

The end date for filtering the prompt's visibility data. Format should be a string.

startDatestring

The start date for filtering the prompt's visibility data. Format should be a string.

Response

successful operation

aiAssistantsstring[] required

An array of AI assistants associated with the prompt.

businessUnitIdstring required

The identifier for the business unit associated with the prompt.

buyingJourneyPhasestring

The phase of the buying journey that the prompt is associated with.

createdAtstring date-time required

The date and time when the prompt was created, in ISO 8601 format.

idstring required

The unique identifier for the prompt.

languagestring

The language in which the prompt is written.

promptstring required

The text of the prompt.

visibilityobject

An object representing the visibility settings of the prompt.