Get Leaderboards
curl --request GET \
--url https://api.heralded.ai/v1/leaderboardsimport requests
url = "https://api.heralded.ai/v1/leaderboards"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.heralded.ai/v1/leaderboards', 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/leaderboards",
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.heralded.ai/v1/leaderboards"
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.heralded.ai/v1/leaderboards")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/leaderboards")
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_body{
"brands": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"audience": "<string>",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"change_state": "up",
"domain": "<string>",
"engines": {},
"figures": {
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"hq_country": "<string>",
"medals": {
"first": 0,
"second": 0,
"third": 0
},
"mentioned_by": [
"<string>"
],
"name": "<string>",
"placements": [
{
"industry": "<string>",
"label": "<string>",
"rank": 123,
"ranked": 0,
"score": 123
}
],
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"recommended_by": [
"<string>"
],
"score_series": [
{
"month": "<string>",
"rank": 123,
"score": 123,
"state": "ranked"
}
],
"sides": {
"ai": {
"rank": 123,
"score": 123
},
"search": {
"rank": 123,
"score": 123
}
},
"slug": "<string>",
"state": "new",
"strength": 123
}
],
"total": 123
},
"dropouts": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"slug": "<string>",
"state": "ranked"
}
],
"total": 123
},
"engines": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"engine_id": "<string>",
"top_three": [
{
"audience": "<string>",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"change_state": "up",
"domain": "<string>",
"engines": {},
"figures": {
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"hq_country": "<string>",
"medals": {
"first": 0,
"second": 0,
"third": 0
},
"mentioned_by": [
"<string>"
],
"name": "<string>",
"placements": [
{
"industry": "<string>",
"label": "<string>",
"rank": 123,
"ranked": 0,
"score": 123
}
],
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"recommended_by": [
"<string>"
],
"score_series": [
{
"month": "<string>",
"rank": 123,
"score": 123,
"state": "ranked"
}
],
"sides": {
"ai": {
"rank": 123,
"score": 123
},
"search": {
"rank": 123,
"score": 123
}
},
"slug": "<string>",
"state": "new",
"strength": 123
}
]
}
],
"total": 123
},
"filters": {
"audience": "b2b",
"country": "<string>",
"include_brand_sites": false,
"industry": "<string>",
"month": "<string>",
"order": "default",
"origin_country": "<string>",
"q": "<string>",
"side": "all",
"source_type": "industry_authority"
},
"leader": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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
},
"month": "<string>",
"months": [
"<string>"
],
"movers": {
"fallers": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"slug": "<string>",
"state": "ranked"
}
],
"total": 123
},
"risers": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"slug": "<string>",
"state": "ranked"
}
],
"total": 123
}
},
"origin_counts": {},
"population": 123,
"previous_month": "<string>",
"prompts": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"industry": "<string>",
"language": "<string>",
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"winners": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"total": 123
},
"ranked": true,
"sources": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"answers": 123,
"citations": 123,
"domain": "<string>",
"engines": [
"<string>"
],
"pages": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"citations": 123,
"kind": "<string>",
"mentions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"recommends": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"title": "<string>",
"url": "<string>"
}
],
"total": 123,
"withheld": [
123
]
},
"rank": 123,
"source_type": "<string>"
}
],
"state": "complete",
"total": 123,
"withheld": [
123
]
}
}{
"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": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be greater than or equal to 1",
"type": "greater_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": 60,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}Leaderboards
Get Leaderboards
Published measurements under one market and optional filters. No credential required.
GET
/
v1
/
leaderboards
Get Leaderboards
curl --request GET \
--url https://api.heralded.ai/v1/leaderboardsimport requests
url = "https://api.heralded.ai/v1/leaderboards"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.heralded.ai/v1/leaderboards', 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/leaderboards",
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.heralded.ai/v1/leaderboards"
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.heralded.ai/v1/leaderboards")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/leaderboards")
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_body{
"brands": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"audience": "<string>",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"change_state": "up",
"domain": "<string>",
"engines": {},
"figures": {
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"hq_country": "<string>",
"medals": {
"first": 0,
"second": 0,
"third": 0
},
"mentioned_by": [
"<string>"
],
"name": "<string>",
"placements": [
{
"industry": "<string>",
"label": "<string>",
"rank": 123,
"ranked": 0,
"score": 123
}
],
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"recommended_by": [
"<string>"
],
"score_series": [
{
"month": "<string>",
"rank": 123,
"score": 123,
"state": "ranked"
}
],
"sides": {
"ai": {
"rank": 123,
"score": 123
},
"search": {
"rank": 123,
"score": 123
}
},
"slug": "<string>",
"state": "new",
"strength": 123
}
],
"total": 123
},
"dropouts": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"slug": "<string>",
"state": "ranked"
}
],
"total": 123
},
"engines": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"engine_id": "<string>",
"top_three": [
{
"audience": "<string>",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"change_state": "up",
"domain": "<string>",
"engines": {},
"figures": {
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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": "calibrating"
},
"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>"
]
},
"breaks": [
{
"added": [],
"part": "<string>",
"removed": [],
"value": "<string>"
}
],
"high": 123,
"key": {
"answer_pack_version": 123,
"ecommerce": true,
"engines": [
"<string>"
],
"keyword_set_hash": "<string>",
"markets": {},
"passes": 123,
"score_version": "<string>",
"sells_to": "businesses",
"shopping_pack_version": 123,
"sides": [
"ai"
],
"understood_measure": "statements"
},
"low": 123,
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"value": 123
}
],
"value": 123
}
},
"hq_country": "<string>",
"medals": {
"first": 0,
"second": 0,
"third": 0
},
"mentioned_by": [
"<string>"
],
"name": "<string>",
"placements": [
{
"industry": "<string>",
"label": "<string>",
"rank": 123,
"ranked": 0,
"score": 123
}
],
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"recommended_by": [
"<string>"
],
"score_series": [
{
"month": "<string>",
"rank": 123,
"score": 123,
"state": "ranked"
}
],
"sides": {
"ai": {
"rank": 123,
"score": 123
},
"search": {
"rank": 123,
"score": 123
}
},
"slug": "<string>",
"state": "new",
"strength": 123
}
]
}
],
"total": 123
},
"filters": {
"audience": "b2b",
"country": "<string>",
"include_brand_sites": false,
"industry": "<string>",
"month": "<string>",
"order": "default",
"origin_country": "<string>",
"q": "<string>",
"side": "all",
"source_type": "industry_authority"
},
"leader": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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
},
"month": "<string>",
"months": [
"<string>"
],
"movers": {
"fallers": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"slug": "<string>",
"state": "ranked"
}
],
"total": 123
},
"risers": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"name": "<string>",
"previous_rank": 123,
"rank": 123,
"rank_change": 123,
"slug": "<string>",
"state": "ranked"
}
],
"total": 123
}
},
"origin_counts": {},
"population": 123,
"previous_month": "<string>",
"prompts": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"industry": "<string>",
"language": "<string>",
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"winners": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"total": 123
},
"ranked": true,
"sources": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"answers": 123,
"citations": 123,
"domain": "<string>",
"engines": [
"<string>"
],
"pages": {
"limit": 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_cursor": "<string>",
"offset": 123,
"rows": [
{
"citations": 123,
"kind": "<string>",
"mentions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"recommends": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"title": "<string>",
"url": "<string>"
}
],
"total": 123,
"withheld": [
123
]
},
"rank": 123,
"source_type": "<string>"
}
],
"state": "complete",
"total": 123,
"withheld": [
123
]
}
}{
"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": "invalid_request",
"detail": "The request's parameters are invalid; `errors` names each one.",
"errors": [
{
"loc": [
"query",
"limit"
],
"msg": "Input should be greater than or equal to 1",
"type": "greater_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": 60,
"remaining": 0,
"reset": 60,
"window": 60
},
"status": 429,
"title": "Too Many Requests",
"type": "https://docs.heralded.ai/errors-and-limits#rate_limited"
}Query Parameters
Response
Successful Response