Get Prompt
curl --request GET \
--url https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}import requests
url = "https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyPrompts
Get Prompt
Retrieve detailed information about a specific prompt
GET
/
api
/
v1
/
brands
/
{brandId}
/
prompts
/
{promptId}
Get Prompt
curl --request GET \
--url https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}import requests
url = "https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brandId}/prompts/{promptId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyRetrieve detailed information about a single prompt, including aggregated metrics across all its answers.
Example with
Path Parameters
The unique identifier of the brand
The unique identifier of the prompt
Query Parameters
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
}
}
⌘I

