curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/overview"
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}/overview', 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}/overview",
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}/overview"
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}/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/overview")
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{
"actions": [
{
"citation_count": 0,
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"demand": "<string>",
"detail": "<string>",
"done_when": "<string>",
"ending": {
"at": "2023-11-07T05:31:56Z",
"key": "<string>",
"label": "<string>"
},
"evidence": {
"answers_link": {
"href": "<string>"
},
"prompts": [
{
"answer_count": 123,
"answers_link": {
"href": "<string>"
},
"named_count": 123,
"prompt_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>"
}
]
},
"first_citation": {
"answer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cited_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"engine_id": "<string>",
"mark_id": "<string>",
"prompt": "<string>",
"prompt_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"focus": {
"id": "<string>",
"kind": "topic",
"name": "<string>"
},
"gain": {
"aims_at": "<string>",
"band": "high"
},
"grounds": {
"cause": "<string>",
"evidence": [
{
"fact": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"measure": "<string>",
"url": "<string>"
}
],
"guidance": [
{
"checked_on": "2023-12-25",
"publisher": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"kind": "your_data",
"observed_at": "2023-11-07T05:31:56Z",
"targets": [
{
"engine": "<string>",
"kind": "prompt",
"language": "<string>",
"metric": "recommended",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"why": "<string>"
},
"group": "new",
"holder": "you",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"kind_tag": "<string>",
"member": "writer",
"not_seen_since_run": 123,
"note": {
"how_well_know": "<string>",
"short_form": "<string>",
"what_i_need_from_you": "<string>",
"what_ill_do": "<string>",
"whats_happening": "<string>",
"why_it_matters": "<string>"
},
"outcome": "verified_up",
"paid_off_at": "2023-11-07T05:31:56Z",
"placed_position": 123,
"preview": "<string>",
"route": "<string>",
"scheduled_for": "2023-12-25",
"stage": "observe",
"started_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"tracking": [
"live"
],
"wait": {
"acts": "heralded",
"due_on": "2023-12-25",
"due_source": "given",
"kind": "answer",
"on": "<string>",
"since": "2023-11-07T05:31:56Z"
},
"waiting_since": "2023-11-07T05:31:56Z",
"write_language": "<string>",
"write_language_locked": false,
"write_language_source": "<string>"
}
],
"answers_citing_you": {
"count": 123,
"of": 123,
"pct": 123
},
"attribution": {
"by_voice": [
{
"count": 123,
"platform": "<string>",
"voice": "<string>"
}
],
"period": "<string>",
"total": 123
},
"competitor_rank": {
"of": 123,
"position": 123
},
"counts": {
"emails_to_file": 123,
"found_7d": 123,
"open": 123,
"proposed": 123,
"scheduled": 123,
"scheduled_runs": 123,
"setup": 123,
"suggestions_kept": 123,
"to_do": 123,
"waiting": 123,
"working": 123,
"your_turn": 123
},
"daily_scans_since_weekly": 123,
"diagnosis": {
"drafts": {
"draftable": 123,
"ready": 123
},
"rival_gaps": {
"count": 123,
"prompts": 123,
"top": [
"<string>"
]
},
"rival_sources": {
"count": 123,
"top": [
"<string>"
],
"unavailable_scans": 123
}
},
"headline": {},
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"heralded_score_band": "<string>",
"latest_read": {
"actions_found": 123,
"read_at": "2023-11-07T05:31:56Z",
"run_number": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"last_attempt_failed": false,
"partial": false,
"query": {},
"surfaces": {},
"updating": false
},
"next_daily_scan_at": "2023-11-07T05:31:56Z",
"next_weekly_scan_at": "2023-11-07T05:31:56Z",
"open_action_count": 123,
"period": {
"excluded_reports": 123,
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"preset": "1w",
"reports": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"readiness": {
"pages_blocked": 123,
"pages_checked": 123,
"pages_readable": 123,
"pages_unmeasured": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"report": {
"actions_found": 123,
"read_at": "2023-11-07T05:31:56Z",
"run_number": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"rivals": [
{
"brand_key": "<string>",
"description": "<string>",
"domain": "<string>",
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"is_you": true,
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned_since": "2023-11-07T05:31:56Z",
"most_said_against": "<string>",
"most_said_for": "<string>",
"name": "<string>",
"product_cards": {
"average_position": 123,
"best_position": 123,
"in_product_cards": {
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"value": 123
},
"state": "read",
"weeks": 0
},
"rank": 123,
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"share_of_voice_pct": 123
}
],
"score_bands": [
{
"high": 123,
"label": "<string>",
"low": 123
}
],
"score_context": {
"answers": 123,
"brand_name": "<string>",
"engines": 123,
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"prompts": 123
},
"sides": {
"ai": {
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"all": {
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"search": {
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
}
}
},
"sides_available": [
"ai"
],
"since_started": {
"current": 123,
"first": 123,
"first_report_at": "2023-11-07T05:31:56Z",
"series": [
{
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"completed_at": "2023-11-07T05:31:56Z",
"degraded": true,
"run_number": 123,
"value": 123
}
],
"third_report_due_at": "2023-11-07T05:31:56Z"
},
"source_citation_evidence": "complete",
"source_unavailable_scans": 0,
"sources": [
{
"citation_share_pct": 123,
"citations": 123,
"domain": "<string>",
"group": "own",
"ownership": "own",
"read_pages_naming_you": 123
}
],
"sources_mentioning_you": {
"count": 123,
"of": 123,
"pct": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"verified_actions": {
"rows": [
{
"action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"after": 123,
"before": 123,
"citation_count": 0,
"completed_at": "2023-11-07T05:31:56Z",
"credited_pts": 123,
"first_citation": {
"answer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cited_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"engine_id": "<string>",
"mark_id": "<string>",
"prompt": "<string>",
"prompt_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"gain": "<string>",
"happened": "<string>",
"title": "<string>"
}
],
"total": 123
}
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_cursor"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_token"
}{
"code": "insufficient_scope",
"detail": "The credential does not have the scope this operation requires.",
"instance": "example-request-id",
"status": 403,
"title": "Forbidden",
"type": "https://docs.heralded.ai/errors-and-limits#insufficient_scope"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "https://docs.heralded.ai/errors-and-limits#not_found"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "https://docs.heralded.ai/errors-and-limits#workspace_archived"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_request"
}{
"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": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}Get Overview
A brand’s figures over the selected period with ranges, states and change,
the score’s band, the latest weekly report and citation metrics, the top
five rivals, the five most cited sources and the five newest open actions, the next
weekly and daily scan times, the daily scans since the last weekly scan, the open
action count, how many pages AI engines cannot read, what the score was read from,
its move since the first weekly scan and the work verified as paying off.
with_diagnosis adds what rivals win over the last week. lean leaves out the
rivals, sources, actions, attribution and readiness.
curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/overview"
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}/overview', 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}/overview",
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}/overview"
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}/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/overview")
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{
"actions": [
{
"citation_count": 0,
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"demand": "<string>",
"detail": "<string>",
"done_when": "<string>",
"ending": {
"at": "2023-11-07T05:31:56Z",
"key": "<string>",
"label": "<string>"
},
"evidence": {
"answers_link": {
"href": "<string>"
},
"prompts": [
{
"answer_count": 123,
"answers_link": {
"href": "<string>"
},
"named_count": 123,
"prompt_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>"
}
]
},
"first_citation": {
"answer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cited_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"engine_id": "<string>",
"mark_id": "<string>",
"prompt": "<string>",
"prompt_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"focus": {
"id": "<string>",
"kind": "topic",
"name": "<string>"
},
"gain": {
"aims_at": "<string>",
"band": "high"
},
"grounds": {
"cause": "<string>",
"evidence": [
{
"fact": "<string>",
"observed_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"measure": "<string>",
"url": "<string>"
}
],
"guidance": [
{
"checked_on": "2023-12-25",
"publisher": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"kind": "your_data",
"observed_at": "2023-11-07T05:31:56Z",
"targets": [
{
"engine": "<string>",
"kind": "prompt",
"language": "<string>",
"metric": "recommended",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"why": "<string>"
},
"group": "new",
"holder": "you",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"kind_tag": "<string>",
"member": "writer",
"not_seen_since_run": 123,
"note": {
"how_well_know": "<string>",
"short_form": "<string>",
"what_i_need_from_you": "<string>",
"what_ill_do": "<string>",
"whats_happening": "<string>",
"why_it_matters": "<string>"
},
"outcome": "verified_up",
"paid_off_at": "2023-11-07T05:31:56Z",
"placed_position": 123,
"preview": "<string>",
"route": "<string>",
"scheduled_for": "2023-12-25",
"stage": "observe",
"started_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"tracking": [
"live"
],
"wait": {
"acts": "heralded",
"due_on": "2023-12-25",
"due_source": "given",
"kind": "answer",
"on": "<string>",
"since": "2023-11-07T05:31:56Z"
},
"waiting_since": "2023-11-07T05:31:56Z",
"write_language": "<string>",
"write_language_locked": false,
"write_language_source": "<string>"
}
],
"answers_citing_you": {
"count": 123,
"of": 123,
"pct": 123
},
"attribution": {
"by_voice": [
{
"count": 123,
"platform": "<string>",
"voice": "<string>"
}
],
"period": "<string>",
"total": 123
},
"competitor_rank": {
"of": 123,
"position": 123
},
"counts": {
"emails_to_file": 123,
"found_7d": 123,
"open": 123,
"proposed": 123,
"scheduled": 123,
"scheduled_runs": 123,
"setup": 123,
"suggestions_kept": 123,
"to_do": 123,
"waiting": 123,
"working": 123,
"your_turn": 123
},
"daily_scans_since_weekly": 123,
"diagnosis": {
"drafts": {
"draftable": 123,
"ready": 123
},
"rival_gaps": {
"count": 123,
"prompts": 123,
"top": [
"<string>"
]
},
"rival_sources": {
"count": 123,
"top": [
"<string>"
],
"unavailable_scans": 123
}
},
"headline": {},
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"heralded_score_band": "<string>",
"latest_read": {
"actions_found": 123,
"read_at": "2023-11-07T05:31:56Z",
"run_number": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"last_attempt_failed": false,
"partial": false,
"query": {},
"surfaces": {},
"updating": false
},
"next_daily_scan_at": "2023-11-07T05:31:56Z",
"next_weekly_scan_at": "2023-11-07T05:31:56Z",
"open_action_count": 123,
"period": {
"excluded_reports": 123,
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"preset": "1w",
"reports": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"readiness": {
"pages_blocked": 123,
"pages_checked": 123,
"pages_readable": 123,
"pages_unmeasured": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"report": {
"actions_found": 123,
"read_at": "2023-11-07T05:31:56Z",
"run_number": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"rivals": [
{
"brand_key": "<string>",
"description": "<string>",
"domain": "<string>",
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"is_you": true,
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned_since": "2023-11-07T05:31:56Z",
"most_said_against": "<string>",
"most_said_for": "<string>",
"name": "<string>",
"product_cards": {
"average_position": 123,
"best_position": 123,
"in_product_cards": {
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"value": 123
},
"state": "read",
"weeks": 0
},
"rank": 123,
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"share_of_voice_pct": 123
}
],
"score_bands": [
{
"high": 123,
"label": "<string>",
"low": 123
}
],
"score_context": {
"answers": 123,
"brand_name": "<string>",
"engines": 123,
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"prompts": 123
},
"sides": {
"ai": {
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"all": {
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"search": {
"heralded_score": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"mentioned": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"praised": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"recommended": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
}
}
},
"sides_available": [
"ai"
],
"since_started": {
"current": 123,
"first": 123,
"first_report_at": "2023-11-07T05:31:56Z",
"series": [
{
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"completed_at": "2023-11-07T05:31:56Z",
"degraded": true,
"run_number": 123,
"value": 123
}
],
"third_report_due_at": "2023-11-07T05:31:56Z"
},
"source_citation_evidence": "complete",
"source_unavailable_scans": 0,
"sources": [
{
"citation_share_pct": 123,
"citations": 123,
"domain": "<string>",
"group": "own",
"ownership": "own",
"read_pages_naming_you": 123
}
],
"sources_mentioning_you": {
"count": 123,
"of": 123,
"pct": 123
},
"understood": {
"answers": 123,
"basis": "ai",
"change": {
"baseline": {
"first_answer_at": "2023-11-07T05:31:56Z",
"last_answer_at": "2023-11-07T05:31:56Z",
"reports": 123
},
"cells_unpaired": 123,
"compared_engines": [
"<string>"
],
"delta": 123,
"direction": "up",
"high": 123,
"low": 123,
"real": true,
"state": "up"
},
"denominator": 123,
"high": 123,
"low": 123,
"numerator": 123,
"state": "<string>",
"trend": [
{
"answers": 123,
"at": "2023-11-07T05:31:56Z",
"break": {
"at": "2023-12-25",
"comparable": true,
"engines_added": [
"<string>"
],
"engines_removed": [
"<string>"
],
"parts": [
"<string>"
]
},
"high": 123,
"low": 123,
"state": "<string>",
"value": 123
}
],
"value": 123
},
"verified_actions": {
"rows": [
{
"action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"after": 123,
"before": 123,
"citation_count": 0,
"completed_at": "2023-11-07T05:31:56Z",
"credited_pts": 123,
"first_citation": {
"answer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cited_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"engine_id": "<string>",
"mark_id": "<string>",
"prompt": "<string>",
"prompt_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"gain": "<string>",
"happened": "<string>",
"title": "<string>"
}
],
"total": 123
}
}{
"code": "invalid_cursor",
"detail": "The cursor is invalid or belongs to a different query.",
"instance": "example-request-id",
"status": 400,
"title": "Bad Request",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_cursor"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_token"
}{
"code": "insufficient_scope",
"detail": "The credential does not have the scope this operation requires.",
"instance": "example-request-id",
"status": 403,
"title": "Forbidden",
"type": "https://docs.heralded.ai/errors-and-limits#insufficient_scope"
}{
"code": "not_found",
"detail": "Nothing here that this API key can read.",
"instance": "example-request-id",
"status": 404,
"title": "Not Found",
"type": "https://docs.heralded.ai/errors-and-limits#not_found"
}{
"code": "workspace_archived",
"detail": "The API key's organization is archived.",
"instance": "example-request-id",
"status": 409,
"title": "Conflict",
"type": "https://docs.heralded.ai/errors-and-limits#workspace_archived"
}{
"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": "https://docs.heralded.ai/errors-and-limits#invalid_request"
}{
"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": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}Authorizations
An organisation service token, sent as Authorization: Bearer hrld_svc_... Scopes: scans:start starts service scans; scans:read reads them; managed:read reads brands, profile, overview, scores, competitors, actions and Snapshots in actively managed organisations; managed:share makes their restricted Snapshots unlisted.
Query Parameters
Response
Successful Response