HUhubspot
Basic

Retrieve prompt run

Changed on

Retrieve detailed information about a specific prompt run using its unique identifier. This endpoint provides insights into the run's state, associated AI model, citations, and mentions. It is useful for tracking the progress and results of a prompt run within the Answer Engine Visibility system.

get/marketing/aeo/2027-03-beta/prompt-runs/{runUuid}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/marketing/aeo/2027-03-beta/prompt-runs/{runUuid}
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: marketing.aeo.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: marketing.aeo.read

Path parameters

runUuidstring required

Response

successful operation

aiModelstring required

The AI model used for this prompt run.

competitorMentionsinteger required

The number of mentions related to competitors in the context of this prompt run.

completedAtstring date-time

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

createdAtstring date-time required

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

idstring required

The unique identifier for this prompt run.

ownedMentionsinteger required

The number of mentions owned by the entity running the prompt.

promptIdstring required

The unique identifier of the prompt associated with this run.

responseTextstring

The text response generated by the prompt run.

searchQueriesstring[] required

An array of search queries used during the prompt run.

statestring required

The current state of the prompt run.

totalCitationsinteger required

The total number of citations associated with this prompt run.

updatedAtstring date-time required

The date and time when this prompt run was last updated, in ISO 8601 format.

Changes

  • 2027-03-beta3e1835f1fe1dRevision changes
    • info

      the security scope marketing.aeo.write was added to the endpoint's security scheme oauth2

    • info

      the security scope marketing.aeo.read was removed from the endpoint's security scheme oauth2

  • 2027-03-beta53bae9def894Revision changes
    • info

      the security scope marketing.aeo.write was added to the endpoint's security scheme oauth2

    • info

      the security scope marketing.aeo.read was removed from the endpoint's security scheme oauth2