AI-visibility overview
curl --request GET \
--url https://api.spreadjam.com/v1/analytics/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spreadjam.com/v1/analytics/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{
"project": {
"id": "<string>",
"brandName": "<string>",
"siteDomain": "<string>",
"status": "<string>",
"bootstrapCompletedAt": "2023-11-07T05:31:56Z",
"lastVisibilitySuccessAt": "2023-11-07T05:31:56Z"
},
"selection": {
"range": "<string>",
"providerIds": [
"<string>"
],
"segmentIds": [
"<string>"
]
},
"metricSource": "analytics_dashboard",
"metricDefinitions": {
"percentages": "<string>",
"prompts": "<string>",
"visibility": "<string>",
"citations": "<string>",
"scope": "<string>",
"counts": "<string>"
},
"client": {
"name": "<string>",
"domain": "<string>",
"description": "<string>",
"lastScanAt": "<string>"
},
"window": {
"label": "<string>",
"comparisonLabel": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"answerCount": 123,
"providerCount": 123,
"pinned": true
},
"providers": [
{
"id": "<string>",
"label": "<string>",
"status": "active",
"health": {
"scanAt": "<string>",
"settled": 123,
"answered": 123,
"failed": 123,
"failureRate": 123,
"errors": [
{
"code": "<string>",
"count": 123
}
],
"degraded": true,
"reason": "<string>"
}
}
],
"overview": {
"visibilityScore": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationShare": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"averagePosition": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"trend": {
"brands": [
{
"key": "<string>",
"name": "<string>",
"domain": "<string>",
"isOwned": true
}
],
"points": [
{
"date": "<string>",
"scores": {}
}
],
"unit": "<string>"
},
"leaderboard": [
{
"rank": 123,
"brand": {
"key": "<string>",
"name": "<string>",
"domain": "<string>",
"isOwned": true
},
"visibilityScore": 123,
"delta": 123,
"citationShare": 123,
"averagePosition": 123,
"mentions": 123
}
],
"providerBreakdown": [
{
"providerId": "<string>",
"visibilityScore": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationShare": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"averagePosition": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"answerCount": 123,
"status": "active",
"health": {
"scanAt": "<string>",
"settled": 123,
"answered": 123,
"failed": 123,
"failureRate": 123,
"errors": [
{
"code": "<string>",
"count": 123
}
],
"degraded": true,
"reason": "<string>"
}
}
],
"changeFeed": [
{
"id": "<string>",
"date": "<string>",
"kind": "<string>",
"label": "<string>"
}
],
"topicRankings": [
{
"topic": "<string>",
"promptCount": 123,
"eligibleObservationCount": 123,
"ranked": [
{
"brandKey": "<string>",
"visibilityScore": 123
}
],
"rankingAvailable": true
}
],
"mentionCohortCount": 123,
"leadWithTopics": true
},
"trackedPrompts": 123,
"promptsTracked": 123,
"promptsMeasured": 123,
"lastScanAt": "<string>",
"nextScanAt": "<string>",
"researchSnapshot": {
"revision": "<string>",
"asOf": "<string>",
"capped": true
},
"metricNotes": {},
"sectionNotices": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}Analytics
AI-visibility overview
The numbers the analytics dashboard shows for the window: visibility, citation share and position with deltas, per platform, the brand leaderboard and topic rankings, plus the last and next scan. Send X-Jam-Project to pick a project.
GET
/
v1
/
analytics
/
overview
AI-visibility overview
curl --request GET \
--url https://api.spreadjam.com/v1/analytics/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/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.spreadjam.com/v1/analytics/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spreadjam.com/v1/analytics/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{
"project": {
"id": "<string>",
"brandName": "<string>",
"siteDomain": "<string>",
"status": "<string>",
"bootstrapCompletedAt": "2023-11-07T05:31:56Z",
"lastVisibilitySuccessAt": "2023-11-07T05:31:56Z"
},
"selection": {
"range": "<string>",
"providerIds": [
"<string>"
],
"segmentIds": [
"<string>"
]
},
"metricSource": "analytics_dashboard",
"metricDefinitions": {
"percentages": "<string>",
"prompts": "<string>",
"visibility": "<string>",
"citations": "<string>",
"scope": "<string>",
"counts": "<string>"
},
"client": {
"name": "<string>",
"domain": "<string>",
"description": "<string>",
"lastScanAt": "<string>"
},
"window": {
"label": "<string>",
"comparisonLabel": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"answerCount": 123,
"providerCount": 123,
"pinned": true
},
"providers": [
{
"id": "<string>",
"label": "<string>",
"status": "active",
"health": {
"scanAt": "<string>",
"settled": 123,
"answered": 123,
"failed": 123,
"failureRate": 123,
"errors": [
{
"code": "<string>",
"count": 123
}
],
"degraded": true,
"reason": "<string>"
}
}
],
"overview": {
"visibilityScore": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationShare": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"averagePosition": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"trend": {
"brands": [
{
"key": "<string>",
"name": "<string>",
"domain": "<string>",
"isOwned": true
}
],
"points": [
{
"date": "<string>",
"scores": {}
}
],
"unit": "<string>"
},
"leaderboard": [
{
"rank": 123,
"brand": {
"key": "<string>",
"name": "<string>",
"domain": "<string>",
"isOwned": true
},
"visibilityScore": 123,
"delta": 123,
"citationShare": 123,
"averagePosition": 123,
"mentions": 123
}
],
"providerBreakdown": [
{
"providerId": "<string>",
"visibilityScore": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationShare": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"averagePosition": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"answerCount": 123,
"status": "active",
"health": {
"scanAt": "<string>",
"settled": 123,
"answered": 123,
"failed": 123,
"failureRate": 123,
"errors": [
{
"code": "<string>",
"count": 123
}
],
"degraded": true,
"reason": "<string>"
}
}
],
"changeFeed": [
{
"id": "<string>",
"date": "<string>",
"kind": "<string>",
"label": "<string>"
}
],
"topicRankings": [
{
"topic": "<string>",
"promptCount": 123,
"eligibleObservationCount": 123,
"ranked": [
{
"brandKey": "<string>",
"visibilityScore": 123
}
],
"rankingAvailable": true
}
],
"mentionCohortCount": 123,
"leadWithTopics": true
},
"trackedPrompts": 123,
"promptsTracked": 123,
"promptsMeasured": 123,
"lastScanAt": "<string>",
"nextScanAt": "<string>",
"researchSnapshot": {
"revision": "<string>",
"asOf": "<string>",
"capped": true
},
"metricNotes": {},
"sectionNotices": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"docs": "<string>",
"resolveUrl": "<string>",
"details": [
{}
]
}Authorizations
Response
The visibility overview.
The analytics dashboard model for the selection: the same numbers the dashboard shows. Percentages are 0-100; a null value means unavailable, never zero. Read metricDefinitions before quoting a number.