Skip to main content
GET
/
api
/
v1
/
brands
/
{brandId}
/
prompts
/
{promptId}
Get Prompt
curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}
Retrieve detailed information about a single prompt, including aggregated metrics across all its answers.

​
Path Parameters

​
brandId
string
required
The unique identifier of the brand
​
promptId
string
required
The unique identifier of the prompt

​
Query Parameters

​
include
string
Set to details to enrich the prompt with aggregated competitors, sources, brand mentions, and source stability metrics. When omitted, returns the base fields only.

​
Response

Returns detailed prompt information with aggregated metrics.

​
Example Response

{
  "success": true,
  "prompt": {
    "id": "q1",
    "text": "What are the best products in this category?",
    "topic": {
      "id": "topic1",
      "name": "Product Reviews"
    },
    "type": "TOFU",
    "tags": [
      { "id": "tag1", "name": "reviews" },
      { "id": "tag2", "name": "comparison" }
    ],
    "answersCount": 2,
    "mentionRate": 50.0,
    "sourceRate": 25.0,
    "avgSentiment": 78.5,
    "createdAt": "2024-12-01T10:00:00.000Z",
    "lastGeneratedAt": "2024-12-19T10:00:00.000Z"
  }
}

​
Example with include=details

{
  "success": true,
  "prompt": {
    "id": "q1",
    "text": "What are the best products in this category?",
    "topic": {
      "id": "topic1",
      "name": "Product Reviews"
    },
    "type": "TOFU",
    "tags": [
      { "id": "tag1", "name": "reviews" },
      { "id": "tag2", "name": "comparison" }
    ],
    "answersCount": 2,
    "mentionRate": 50.0,
    "sourceRate": 25.0,
    "avgSentiment": 78.5,
    "createdAt": "2024-12-01T10:00:00.000Z",
    "lastGeneratedAt": "2024-12-19T10:00:00.000Z",
    "competitors": [
      { "name": "My Brand", "mentions": 3, "relationship": "SELF" },
      { "name": "Competitor A", "mentions": 8, "relationship": "DIRECT" }
    ],
    "competitorsCount": 2,
    "competitorMentionsTotal": 11,
    "brandMentioned": true,
    "brandMentionCount": 3,
    "sources": [
      { "domain": "mybrand.com", "citations": 2, "isSelf": true },
      { "domain": "expert-reviews.com", "citations": 4, "isSelf": false }
    ],
    "sourcesCount": 2,
    "sourceCitationsTotal": 6,
    "sourceStability": 50.0
  }
}