curl --request GET \
--url https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}', 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://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"prompt_response": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"response_text": "<string>",
"checked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"response_metadata": {},
"prompt": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_text": "<string>",
"status": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_volume_hydrated": true,
"keyword": "<string>",
"search_volume": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"brand_visibility": 123,
"search_volume_level": 123,
"project": null,
"topic": {},
"country": {
"code": "<string>",
"name": "<string>",
"is_active": true,
"flag": "<string>",
"primary_language": "<string>"
},
"tags": [
{}
]
},
"service": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"name": "<string>",
"display_name": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"prompt": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_text": "<string>",
"status": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_volume_hydrated": true,
"keyword": "<string>",
"search_volume": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"brand_visibility": 123,
"search_volume_level": 123,
"project": null,
"topic": {},
"country": {
"code": "<string>",
"name": "<string>",
"is_active": true,
"flag": "<string>",
"primary_language": "<string>"
},
"tags": [
{}
]
},
"service": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"name": "<string>",
"display_name": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"sources": [
{
"url": "<string>",
"domain": "<string>",
"hostname": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>"
}
],
"brand_mentions": [
{
"sentiment": "<string>",
"salience_score": "<string>",
"rank": 123,
"mention_snippet": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"fan_out_queries": [
{
"query": "<string>",
"rank": 123
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}Get Response
Full detail for a single AI response: the response record, its prompt (with target country), the platform, cited sources, and any brand mentions.
curl --request GET \
--url https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}', 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://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surfacd.com/api/v1/projects/{project}/reputation/responses/{response}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"prompt_response": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"response_text": "<string>",
"checked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"response_metadata": {},
"prompt": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_text": "<string>",
"status": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_volume_hydrated": true,
"keyword": "<string>",
"search_volume": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"brand_visibility": 123,
"search_volume_level": 123,
"project": null,
"topic": {},
"country": {
"code": "<string>",
"name": "<string>",
"is_active": true,
"flag": "<string>",
"primary_language": "<string>"
},
"tags": [
{}
]
},
"service": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"name": "<string>",
"display_name": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"prompt": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_text": "<string>",
"status": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_volume_hydrated": true,
"keyword": "<string>",
"search_volume": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"brand_visibility": 123,
"search_volume_level": 123,
"project": null,
"topic": {},
"country": {
"code": "<string>",
"name": "<string>",
"is_active": true,
"flag": "<string>",
"primary_language": "<string>"
},
"tags": [
{}
]
},
"service": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"name": "<string>",
"display_name": "<string>",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"sources": [
{
"url": "<string>",
"domain": "<string>",
"hostname": "<string>",
"rank": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>"
}
],
"brand_mentions": [
{
"sentiment": "<string>",
"salience_score": "<string>",
"rank": 123,
"mention_snippet": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"fan_out_queries": [
{
"query": "<string>",
"rank": 123
}
]
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Team API key created in Team Settings. Use it with URLs for the same team.
Path Parameters
Project UUID.
The AI response UUID. Scoped to the project's responses; a foreign UUID returns 404.
Response
The response detail.
Full detail for a single AI response behind a reputation mention: the response record, its prompt (with target country), the platform, the cited sources, and any brand mentions.
The raw AI response record behind a reputation mention.
Show child attributes
Show child attributes
The prompt behind a reputation response, with its target country.
Show child attributes
Show child attributes
The AI platform that produced a reputation response.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Web searches the platform ran before answering. Empty for platforms that answer from knowledge alone.
Show child attributes
Show child attributes