Start Snapshot
curl --request POST \
--url https://api.heralded.ai/v1/scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "<string>"
}
'import requests
url = "https://api.heralded.ai/v1/scans"
payload = { "domain": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: '<string>'})
};
fetch('https://api.heralded.ai/v1/scans', 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/scans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'domain' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.heralded.ai/v1/scans"
payload := strings.NewReader("{\n \"domain\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.heralded.ai/v1/scans")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/scans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"audit_progress": {
"found": 123,
"phase": "discovering",
"planned": 123,
"read": 123,
"shots": 123
},
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completed_at": "2023-11-07T05:31:56Z",
"created": true,
"domain": "<string>",
"ecommerce": true,
"failure_reason": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued": {
"heralded_score": {
"answers": 123,
"band": "<string>",
"high": 123,
"low": 123,
"value": 123
},
"mentioned": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
},
"missing_question": {
"answers": 123,
"competitor": "<string>",
"query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question": "<string>"
},
"readiness": {
"pages_blocked": 123,
"pages_checked": 123,
"pages_readable": 123,
"pages_unmeasured": 123
},
"recommended": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
}
},
"kind": "weekly",
"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
},
"partial": true,
"payer": {
"by": "free_snapshot",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"profile": {
"brand_name": "<string>",
"buyer": "<string>",
"category": "<string>",
"competitors": [
"<string>"
],
"description": "<string>",
"market": "<string>"
},
"progress": {
"answers_read": 123,
"answers_total": 123,
"pages_checked": 123,
"pages_total": 123,
"pct": 123,
"phase": "<string>"
},
"questions_asked": 123,
"report_url": "<string>",
"run_request": {
"reason": "<string>",
"state": "requested"
},
"sells_to": "businesses",
"share_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"state": "preparing",
"url": "<string>"
}{
"audit_progress": {
"found": 123,
"phase": "discovering",
"planned": 123,
"read": 123,
"shots": 123
},
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completed_at": "2023-11-07T05:31:56Z",
"created": true,
"domain": "<string>",
"ecommerce": true,
"failure_reason": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued": {
"heralded_score": {
"answers": 123,
"band": "<string>",
"high": 123,
"low": 123,
"value": 123
},
"mentioned": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
},
"missing_question": {
"answers": 123,
"competitor": "<string>",
"query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question": "<string>"
},
"readiness": {
"pages_blocked": 123,
"pages_checked": 123,
"pages_readable": 123,
"pages_unmeasured": 123
},
"recommended": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
}
},
"kind": "weekly",
"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
},
"partial": true,
"payer": {
"by": "free_snapshot",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"profile": {
"brand_name": "<string>",
"buyer": "<string>",
"category": "<string>",
"competitors": [
"<string>"
],
"description": "<string>",
"market": "<string>"
},
"progress": {
"answers_read": 123,
"answers_total": 123,
"pages_checked": 123,
"pages_total": 123,
"pct": 123,
"phase": "<string>"
},
"questions_asked": 123,
"report_url": "<string>",
"run_request": {
"reason": "<string>",
"state": "requested"
},
"sells_to": "businesses",
"share_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"state": "preparing",
"url": "<string>"
}{
"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": "no_credits",
"detail": "No free Snapshot or Snapshot credit can pay for this Snapshot.",
"instance": "example-request-id",
"resets_at": "2026-12-08T09:30:00+00:00",
"status": 402,
"title": "Payment Required",
"type": "https://docs.heralded.ai/errors-and-limits#no_credits"
}{
"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_domain",
"detail": "The domain is not a website Heralded can read. Check its spelling.",
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_domain"
}{
"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"
}{
"code": "scans_temporarily_paused",
"detail": "Heralded has paused new scan starts. Retry later.",
"instance": "example-request-id",
"status": 503,
"title": "Service Unavailable",
"type": "https://docs.heralded.ai/errors-and-limits#scans_temporarily_paused"
}Snapshots
Start Snapshot
Start a Snapshot of a domain as the key’s member, in its organization, and draft
its profile: brand, description and market. Waits up to 15 seconds for the profile;
a null profile is still drafting, and getScan reads it later. Nothing is spent
until runSnapshot. A domain whose Snapshot of yours has not run answers that
Snapshot with 200. Needs a full-access key.
POST
/
v1
/
scans
Start Snapshot
curl --request POST \
--url https://api.heralded.ai/v1/scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "<string>"
}
'import requests
url = "https://api.heralded.ai/v1/scans"
payload = { "domain": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: '<string>'})
};
fetch('https://api.heralded.ai/v1/scans', 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/scans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'domain' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.heralded.ai/v1/scans"
payload := strings.NewReader("{\n \"domain\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.heralded.ai/v1/scans")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heralded.ai/v1/scans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"audit_progress": {
"found": 123,
"phase": "discovering",
"planned": 123,
"read": 123,
"shots": 123
},
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completed_at": "2023-11-07T05:31:56Z",
"created": true,
"domain": "<string>",
"ecommerce": true,
"failure_reason": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued": {
"heralded_score": {
"answers": 123,
"band": "<string>",
"high": 123,
"low": 123,
"value": 123
},
"mentioned": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
},
"missing_question": {
"answers": 123,
"competitor": "<string>",
"query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question": "<string>"
},
"readiness": {
"pages_blocked": 123,
"pages_checked": 123,
"pages_readable": 123,
"pages_unmeasured": 123
},
"recommended": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
}
},
"kind": "weekly",
"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
},
"partial": true,
"payer": {
"by": "free_snapshot",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"profile": {
"brand_name": "<string>",
"buyer": "<string>",
"category": "<string>",
"competitors": [
"<string>"
],
"description": "<string>",
"market": "<string>"
},
"progress": {
"answers_read": 123,
"answers_total": 123,
"pages_checked": 123,
"pages_total": 123,
"pct": 123,
"phase": "<string>"
},
"questions_asked": 123,
"report_url": "<string>",
"run_request": {
"reason": "<string>",
"state": "requested"
},
"sells_to": "businesses",
"share_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"state": "preparing",
"url": "<string>"
}{
"audit_progress": {
"found": 123,
"phase": "discovering",
"planned": 123,
"read": 123,
"shots": 123
},
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completed_at": "2023-11-07T05:31:56Z",
"created": true,
"domain": "<string>",
"ecommerce": true,
"failure_reason": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued": {
"heralded_score": {
"answers": 123,
"band": "<string>",
"high": 123,
"low": 123,
"value": 123
},
"mentioned": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
},
"missing_question": {
"answers": 123,
"competitor": "<string>",
"query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question": "<string>"
},
"readiness": {
"pages_blocked": 123,
"pages_checked": 123,
"pages_readable": 123,
"pages_unmeasured": 123
},
"recommended": {
"high": 123,
"k": 123,
"low": 123,
"n": 123,
"rank": 123,
"rank_of": 123,
"value": 123
}
},
"kind": "weekly",
"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
},
"partial": true,
"payer": {
"by": "free_snapshot",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"profile": {
"brand_name": "<string>",
"buyer": "<string>",
"category": "<string>",
"competitors": [
"<string>"
],
"description": "<string>",
"market": "<string>"
},
"progress": {
"answers_read": 123,
"answers_total": 123,
"pages_checked": 123,
"pages_total": 123,
"pct": 123,
"phase": "<string>"
},
"questions_asked": 123,
"report_url": "<string>",
"run_request": {
"reason": "<string>",
"state": "requested"
},
"sells_to": "businesses",
"share_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"state": "preparing",
"url": "<string>"
}{
"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": "no_credits",
"detail": "No free Snapshot or Snapshot credit can pay for this Snapshot.",
"instance": "example-request-id",
"resets_at": "2026-12-08T09:30:00+00:00",
"status": 402,
"title": "Payment Required",
"type": "https://docs.heralded.ai/errors-and-limits#no_credits"
}{
"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_domain",
"detail": "The domain is not a website Heralded can read. Check its spelling.",
"instance": "example-request-id",
"status": 422,
"title": "Unprocessable Content",
"type": "https://docs.heralded.ai/errors-and-limits#invalid_domain"
}{
"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"
}{
"code": "scans_temporarily_paused",
"detail": "Heralded has paused new scan starts. Retry later.",
"instance": "example-request-id",
"status": 503,
"title": "Service Unavailable",
"type": "https://docs.heralded.ai/errors-and-limits#scans_temporarily_paused"
}Body
application/json
Response
Your Snapshot of this domain that has not run yet.