curl --request GET \
--url https://api.spreadjam.com/v1/analytics/prompts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spreadjam.com/v1/analytics/prompts"
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/prompts', 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/prompts",
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/prompts"
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/prompts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spreadjam.com/v1/analytics/prompts")
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"
},
"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>"
}
}
],
"metricDefinitions": {
"percentages": "<string>",
"prompts": "<string>",
"visibility": "<string>",
"citations": "<string>",
"scope": "<string>",
"counts": "<string>"
},
"prompts": [
{
"id": "<string>",
"text": "<string>",
"topic": "<string>",
"intent": "<string>",
"metrics": {
"visibilityRank": 123,
"visibilityScore": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"shareOfVoice": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"averagePosition": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationShare": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationRank": 123,
"executions": 123
}
}
],
"filters": {
"intents": [
"<string>"
],
"topics": [
"<string>"
],
"platforms": [
"<string>"
],
"query": "<string>"
},
"pageInfo": {
"hasNextPage": true,
"limit": 123,
"totalCount": 123,
"nextCursor": "<string>"
}
}{
"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": [
{}
]
}Per-prompt analytics
The per-prompt numbers the analytics dashboard prompts table shows for the window, one page at a time (default 50, at most 100), in the table order (topic by topic). When pageInfo.hasNextPage is true, pass pageInfo.nextCursor as cursor with the same filters for the next page; pageInfo.totalCount is the number of prompts across all pages. Send X-Jam-Project to pick a project.
curl --request GET \
--url https://api.spreadjam.com/v1/analytics/prompts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.spreadjam.com/v1/analytics/prompts"
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/prompts', 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/prompts",
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/prompts"
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/prompts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spreadjam.com/v1/analytics/prompts")
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"
},
"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>"
}
}
],
"metricDefinitions": {
"percentages": "<string>",
"prompts": "<string>",
"visibility": "<string>",
"citations": "<string>",
"scope": "<string>",
"counts": "<string>"
},
"prompts": [
{
"id": "<string>",
"text": "<string>",
"topic": "<string>",
"intent": "<string>",
"metrics": {
"visibilityRank": 123,
"visibilityScore": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"shareOfVoice": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"averagePosition": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationShare": {
"value": 123,
"delta": 123,
"deltaAvailable": true
},
"citationRank": 123,
"executions": 123
}
}
],
"filters": {
"intents": [
"<string>"
],
"topics": [
"<string>"
],
"platforms": [
"<string>"
],
"query": "<string>"
},
"pageInfo": {
"hasNextPage": true,
"limit": 123,
"totalCount": 123,
"nextCursor": "<string>"
}
}{
"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
Query Parameters
Limit to these AI platform(s), as the dashboard platform picker does (repeat or comma-separate; one of chatgpt, perplexity, gemini, claude, google_ai_overview, google_ai_mode, copilot). Metrics are computed over the selection. A platform the project does not track (and has no answers from) is a 400 that lists the tracked ones.
chatgpt, perplexity, gemini, claude, google_ai_overview, google_ai_mode, copilot Response
The per-prompt analytics page.
The dashboard prompts table, one row per tracked prompt. A prompt that names a roster brand (branded) is out of scope for the cross-brand rates, so its visibility and citation share are null.