List reports
curl --request GET \
--url https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports \
--header 'x-api-key: <api-key>'import requests
url = "https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports', 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://gateway.sanfoundation.com/api/v1/agents/{ref}/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://gateway.sanfoundation.com/api/v1/agents/{ref}/reports"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>",
"slug": "<string>",
"domain": "<string>",
"description": "<string>"
},
"count": 123,
"reports": [
{
"reportId": "<string>",
"agentSlug": "<string>",
"agentCodename": "<string>",
"title": "<string>",
"summary": "<string>",
"analysis": "<string>",
"coverageWindow": {
"windowType": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"asOf": "2023-11-07T05:31:56Z",
"generatedAt": "2023-11-07T05:31:56Z",
"sourceEventIds": [
"<string>"
],
"region": [
"<string>"
],
"situation": {
"headline": "<string>",
"what_happened": "<string>",
"what_changed": "<string>",
"why_it_matters": "<string>"
},
"decisionAdvantage": {
"personal": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
},
"research": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
},
"business_operations": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
},
"trading_investments": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
}
},
"nextLikelyDevelopments": [
"<string>"
],
"confidence": {
"overall": "low",
"notes": [
"<string>"
]
},
"trend": "stable",
"generationReason": "<string>",
"triggerType": "<string>",
"changeScore": 123,
"inboundSignalIds": [
"<string>"
]
}
]
}API Key
List reports
Generated reports for the agent in reverse-chronological order, each containing four audience-lensed sections (personal, research, business_operations, trading_investments) under both situation and decisionAdvantage.
GET
/
api
/
v1
/
agents
/
{ref}
/
reports
List reports
curl --request GET \
--url https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports \
--header 'x-api-key: <api-key>'import requests
url = "https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports', 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://gateway.sanfoundation.com/api/v1/agents/{ref}/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://gateway.sanfoundation.com/api/v1/agents/{ref}/reports"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.sanfoundation.com/api/v1/agents/{ref}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>",
"slug": "<string>",
"domain": "<string>",
"description": "<string>"
},
"count": 123,
"reports": [
{
"reportId": "<string>",
"agentSlug": "<string>",
"agentCodename": "<string>",
"title": "<string>",
"summary": "<string>",
"analysis": "<string>",
"coverageWindow": {
"windowType": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"asOf": "2023-11-07T05:31:56Z",
"generatedAt": "2023-11-07T05:31:56Z",
"sourceEventIds": [
"<string>"
],
"region": [
"<string>"
],
"situation": {
"headline": "<string>",
"what_happened": "<string>",
"what_changed": "<string>",
"why_it_matters": "<string>"
},
"decisionAdvantage": {
"personal": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
},
"research": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
},
"business_operations": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
},
"trading_investments": {
"bottom_line": "<string>",
"recommended_posture": "<string>",
"time_horizon": "<string>"
}
},
"nextLikelyDevelopments": [
"<string>"
],
"confidence": {
"overall": "low",
"notes": [
"<string>"
]
},
"trend": "stable",
"generationReason": "<string>",
"triggerType": "<string>",
"changeScore": 123,
"inboundSignalIds": [
"<string>"
]
}
]
}Authorizations
SAN-issued API key (sk_…) issued from the SAN Agents Dashboard
(Settings → API Keys). Used by every /api/v1/* endpoint; usage
is billed in credits against the owning account's active Stripe
subscription.
Path Parameters
Flexible agent identifier. Accepts any of:
- UUID —
488ed3ff-6a4d-42e5-8e24-44eeef77959c - Name (case-insensitive) —
Noah,noah,NOAH - Slug — lowercase name with spaces as underscores
- External ID —
017,17,069,69(#and zero-padding tolerated)
Query Parameters
Max number of reports to return.
Required range:
1 <= x <= 3Was this page helpful?