curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/prompt-suggestions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/prompt-suggestions"
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}/prompt-suggestions', 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}/prompt-suggestions",
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}/prompt-suggestions"
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}/prompt-suggestions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/prompt-suggestions")
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{
"items": [
{
"best_to_track": true,
"brand_comparison": true,
"clicks": 123,
"demand": {
"label": "<string>",
"source": "search_console",
"value": 123
},
"form": "short",
"form_label": "<string>",
"impressions": 123,
"intent": "<string>",
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"position": 123,
"proposed_type": "<string>",
"reason": "<string>",
"search_volume": 123,
"sources": [
"search_console"
],
"text": "<string>",
"topic": "<string>",
"tracked_segments": [
"<string>"
],
"why": [
{
"key": "search_console",
"label": "<string>"
}
]
}
],
"limit": 123,
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"next_cursor": "<string>",
"offset": 123,
"pool": {
"cap": 123,
"used": 123
},
"sources": {
"heralded": "ready",
"heralded_read_at": "2023-11-07T05:31:56Z",
"search_console": "connected"
},
"state": "ready",
"suggestions": [
{
"intent_label": "<string>",
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"reason": "<string>",
"text": "<string>"
}
],
"total": 123,
"unavailable": [
{
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"provider": "<string>",
"reason": "<string>"
}
]
}{
"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"
}Get Prompt Suggestions
Discover’s ranked recommendations with provenance, form and demand.
segment selects the segment label for best_to_track. Demand names its source;
unknown demand stays null. Measurement names the keyword market, language and
current coverage.keyword_research and coverage.search_volume availability;
a row overrides it where its measurement differs.
Unavailable keyword research does not fall back to older suggestions.
Reads use stored facts and free catalogs, never a paid provider.
curl --request GET \
--url https://api.heralded.ai/v1/brands/{brand_id}/prompt-suggestions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heralded.ai/v1/brands/{brand_id}/prompt-suggestions"
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}/prompt-suggestions', 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}/prompt-suggestions",
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}/prompt-suggestions"
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}/prompt-suggestions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/brands/{brand_id}/prompt-suggestions")
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{
"items": [
{
"best_to_track": true,
"brand_comparison": true,
"clicks": 123,
"demand": {
"label": "<string>",
"source": "search_console",
"value": 123
},
"form": "short",
"form_label": "<string>",
"impressions": 123,
"intent": "<string>",
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"position": 123,
"proposed_type": "<string>",
"reason": "<string>",
"search_volume": 123,
"sources": [
"search_console"
],
"text": "<string>",
"topic": "<string>",
"tracked_segments": [
"<string>"
],
"why": [
{
"key": "search_console",
"label": "<string>"
}
]
}
],
"limit": 123,
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"meta": {
"data_as_of": {
"completed_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"query": {}
},
"next_cursor": "<string>",
"offset": 123,
"pool": {
"cap": 123,
"used": 123
},
"sources": {
"heralded": "ready",
"heralded_read_at": "2023-11-07T05:31:56Z",
"search_console": "connected"
},
"state": "ready",
"suggestions": [
{
"intent_label": "<string>",
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"reason": "<string>",
"text": "<string>"
}
],
"total": 123,
"unavailable": [
{
"measurement": {
"country": "<string>",
"coverage": {
"keyword_research": "available",
"search_volume": "available"
},
"language": "<string>",
"measured_country": "<string>"
},
"provider": "<string>",
"reason": "<string>"
}
]
}{
"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.
1 <= x <= 100x >= 04096200Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Normalized query and newest included scan.
Show child attributes
Show child attributes
Pass as cursor with the same query to read the next page; null at the end.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ready, awaiting_first_scan Show child attributes
Show child attributes
Show child attributes
Show child attributes