curl --request GET \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts', 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/{brand_id}/brand-intelligence/reviews/drafts",
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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts"
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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts")
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{
"generated_at": "2023-11-07T05:31:56Z",
"total": 123,
"limit": 123,
"offset": 123,
"has_more": true,
"items": [
{
"draft": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"model": "<string>",
"draft_text": "<string>",
"status": "draft",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"edited_text": "<string>",
"copied_at": "2023-11-07T05:31:56Z"
},
"platform": "trustpilot",
"rating": 123,
"reviewed_at": "2023-11-07T05:31:56Z",
"review_title": "<string>",
"review_excerpt": "<string>"
}
],
"platform": "trustpilot"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}List Review Response Drafts Route
The Responses tab’s drafts for one brand, scoped to one platform.
Registered AFTER the /reviews/{review_id}/draft-response POST and the
/reviews/drafts/{draft_id} PATCHes but that ordering is incidental —
no other GET on this router takes a path segment after /reviews, so
drafts cannot be swallowed as a {review_id}.
Authorization: _get_brand_or_404 proves the caller owns brand_id;
the service then joins every row through that brand’s OWN advertiser
identity, so a competitor-sourced review’s draft is unreachable here even
if one somehow existed. Platform scoping is a predicate on the review’s
source, not a client-side filter — see
list_review_response_drafts’s docstring for why each of its three
predicates is load-bearing.
No entitlement METER: listing drafts generates nothing and calls no provider, and metering a read would charge a user for opening a tab. It does carry the Responses-tab capability LOCK — a different question (“is this tab on your plan”), Free on every plan today (design §0.5).
curl --request GET \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts', 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/{brand_id}/brand-intelligence/reviews/drafts",
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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts"
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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reviews/drafts")
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{
"generated_at": "2023-11-07T05:31:56Z",
"total": 123,
"limit": 123,
"offset": 123,
"has_more": true,
"items": [
{
"draft": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"model": "<string>",
"draft_text": "<string>",
"status": "draft",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"edited_text": "<string>",
"copied_at": "2023-11-07T05:31:56Z"
},
"platform": "trustpilot",
"rating": 123,
"reviewed_at": "2023-11-07T05:31:56Z",
"review_title": "<string>",
"review_excerpt": "<string>"
}
],
"platform": "trustpilot"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
trustpilot, google 1 <= x <= 100x >= 0Response
Successful Response
The Responses tab's page of drafts for one brand on one platform.
Envelope mirrors BrandReviewsResponse (total/limit/offset/has_more) so
the workspace pages drafts with the same vocabulary it already pages
reviews with. platform echoes the filter that produced the page —
absent means "every platform", which the tab never asks for but the route
supports.
Was this page helpful?