Get Brand Segments
curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/segments \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/segments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heralded.ai/v1/brands/{brand_id}/segments', 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.heralded.ai/v1/brands/{brand_id}/segments",
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.heralded.ai/v1/brands/{brand_id}/segments"
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.heralded.ai/v1/brands/{brand_id}/segments")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/segments")
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{
"comparison": {
"rows": [
{
"axes": [
{
"axis": "<string>",
"change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"label": "<string>",
"population": "<string>",
"value": 123
}
],
"chips": {
"claude": false,
"language": "<string>",
"market": "<string>",
"persona": "<string>"
},
"is_default": true,
"label": "<string>",
"name": "<string>",
"prompt_count": 123,
"retired": true,
"score": 123,
"score_change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"segment_id": "<string>"
}
],
"total": 0
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"personas": [
{
"ai_generated": true,
"audience_type": "<string>",
"description": "<string>",
"fields": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"segment_limit": 123,
"segment_limit_note": "<string>",
"segments": [
{
"config_version": 123,
"country": "<string>",
"engine_selection": [
"<string>"
],
"engine_vocabulary": [
{
"display_name": "<string>",
"engine_id": "<string>",
"sort_order": 123
}
],
"engines": [
"<string>"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_default": true,
"label": "<string>",
"language": "<string>",
"name": "<string>",
"persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_count": 0,
"retired": true,
"subregion": "<string>"
}
],
"vocabulary": {
"languages": {},
"markets": {},
"optional_engines": [
"<string>"
],
"standard_engines": [
"<string>"
],
"subregions": {}
}
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_token",
"detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
"instance": "example-request-id",
"status": 401,
"title": "Unauthorized",
"type": "about:blank"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "about:blank"
}{
"code": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be less than or equal to 100",
"type": "less_than_equal"
}
],
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "about:blank"
}{
"code": "rate_limited",
"detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
"instance": "example-request-id",
"rate_limit": {
"limit": 120,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "about:blank"
}Settings and organizations
Get Brand Segments
Segment configuration and the complete 1w comparison, sorted with Default first.
GET
/
v1
/
brands
/
{brand_id}
/
segments
Get Brand Segments
curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/segments \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/segments"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heralded.ai/v1/brands/{brand_id}/segments', 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.heralded.ai/v1/brands/{brand_id}/segments",
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.heralded.ai/v1/brands/{brand_id}/segments"
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.heralded.ai/v1/brands/{brand_id}/segments")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/segments")
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{
"comparison": {
"rows": [
{
"axes": [
{
"axis": "<string>",
"change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"label": "<string>",
"population": "<string>",
"value": 123
}
],
"chips": {
"claude": false,
"language": "<string>",
"market": "<string>",
"persona": "<string>"
},
"is_default": true,
"label": "<string>",
"name": "<string>",
"prompt_count": 123,
"retired": true,
"score": 123,
"score_change": {
"delta": 123,
"high": 123,
"low": 123,
"real": true
},
"segment_id": "<string>"
}
],
"total": 0
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"personas": [
{
"ai_generated": true,
"audience_type": "<string>",
"description": "<string>",
"fields": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"segment_limit": 123,
"segment_limit_note": "<string>",
"segments": [
{
"config_version": 123,
"country": "<string>",
"engine_selection": [
"<string>"
],
"engine_vocabulary": [
{
"display_name": "<string>",
"engine_id": "<string>",
"sort_order": 123
}
],
"engines": [
"<string>"
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_default": true,
"label": "<string>",
"language": "<string>",
"name": "<string>",
"persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt_count": 0,
"retired": true,
"subregion": "<string>"
}
],
"vocabulary": {
"languages": {},
"markets": {},
"optional_engines": [
"<string>"
],
"standard_engines": [
"<string>"
],
"subregions": {}
}
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}{
"code": "invalid_token",
"detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
"instance": "example-request-id",
"status": 401,
"title": "Unauthorized",
"type": "about:blank"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "about:blank"
}{
"code": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be less than or equal to 100",
"type": "less_than_equal"
}
],
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "about:blank"
}{
"code": "rate_limited",
"detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
"instance": "example-request-id",
"rate_limit": {
"limit": 120,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "about:blank"
}Authorizations
An API key, sent as Authorization: Bearer hrld_....
Path Parameters
Query Parameters
Include only scans up to this completed scan id.
Available options:
mentioned, recommended, prompts, change Response
Successful Response
Show child attributes
Show child attributes
Normalized query and newest included scan.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes