curl --request GET \
--url https://api.scrunchai.com/v1/{brand_id}/audit-scores/site \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scrunchai.com/v1/{brand_id}/audit-scores/site"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scrunchai.com/v1/{brand_id}/audit-scores/site', 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.scrunchai.com/v1/{brand_id}/audit-scores/site",
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.scrunchai.com/v1/{brand_id}/audit-scores/site"
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.scrunchai.com/v1/{brand_id}/audit-scores/site")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrunchai.com/v1/{brand_id}/audit-scores/site")
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{
"brand_id": 123,
"model_version": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"n_pages": 123,
"total_prompts": 123,
"score": {
"retrievability": 123,
"citability": 123
},
"previous": {
"retrievability": 123,
"citability": 123
},
"previous_absent_reason": "no_prior_run",
"previous_absent_detail": "<string>",
"worst_page_url": "<string>",
"best_page_url": "<string>",
"headroom": {
"retrievability": {
"current": 123,
"projected": 123,
"lift": 123,
"signals": 123,
"listable_signals": 123
},
"citeability": {
"current": 123,
"projected": 123,
"lift": 123,
"signals": 123,
"listable_signals": 123
}
},
"selection_changed_since_audit": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Get Site Audit Score
The brand’s site-level AI-visibility score — retrievability and citability rolled up across the whole site (the same numbers the Site Optimization header shows), when it was scored (generated_at), the previous run’s score for a delta, and headroom (the projected site score per metric if every surfaced opportunity is fixed). null when the brand has no audit yet.
curl --request GET \
--url https://api.scrunchai.com/v1/{brand_id}/audit-scores/site \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scrunchai.com/v1/{brand_id}/audit-scores/site"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scrunchai.com/v1/{brand_id}/audit-scores/site', 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.scrunchai.com/v1/{brand_id}/audit-scores/site",
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.scrunchai.com/v1/{brand_id}/audit-scores/site"
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.scrunchai.com/v1/{brand_id}/audit-scores/site")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrunchai.com/v1/{brand_id}/audit-scores/site")
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{
"brand_id": 123,
"model_version": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"n_pages": 123,
"total_prompts": 123,
"score": {
"retrievability": 123,
"citability": 123
},
"previous": {
"retrievability": 123,
"citability": 123
},
"previous_absent_reason": "no_prior_run",
"previous_absent_detail": "<string>",
"worst_page_url": "<string>",
"best_page_url": "<string>",
"headroom": {
"retrievability": {
"current": 123,
"projected": 123,
"lift": 123,
"signals": 123,
"listable_signals": 123
},
"citeability": {
"current": 123,
"projected": 123,
"lift": 123,
"signals": 123,
"listable_signals": 123
}
},
"selection_changed_since_audit": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
A brand's latest site-level score, from its most recent bulk audit run.
The two numbers we put on screen, both 0-100. citability is vs the winning page (50 = parity with it); the loser-side floor stays a diagnostic and isn't surfaced here.
Show child attributes
Show child attributes
The two numbers we put on screen, both 0-100. citability is vs the winning page (50 = parity with it); the loser-side floor stays a diagnostic and isn't surfaced here.
Show child attributes
Show child attributes
no_prior_run, not_comparable Show child attributes
Show child attributes