Get Overview Summary
curl --request GET \
--url https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary \
--header 'Authorization: <authorization>'import requests
url = "https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary', 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.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary",
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: <authorization>"
],
]);
$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.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
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.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"brand": {
"id": 123,
"name": "<string>"
},
"kpis": {
"mentions": {
"mentions": 123,
"runsWithBrand": 123,
"totalRuns": 123,
"mentionRatePct": 123,
"delta": 123
},
"avgPosition": {
"value": 123,
"delta": 123
},
"visibilityPct": {
"value": 123,
"delta": 123
},
"shareOfVoicePct": {
"value": 123,
"delta": 123
}
},
"entities": [
{
"name": "<string>",
"type": "<string>",
"mentions": 123,
"avgPosition": 123,
"visibilityPct": 123,
"shareOfVoicePct": 123
}
],
"platforms": [
{
"platform": "<string>",
"runs": 123,
"mentions": 123,
"visibilityPct": 123
}
]
}Analytics
Get Overview Summary
Retrieve key performance indicators, entity breakdown, and platform stats for your brand.
GET
/
ai-analytics-service
/
api
/
public
/
v1
/
analytics
/
overview
/
summary
Get Overview Summary
curl --request GET \
--url https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary \
--header 'Authorization: <authorization>'import requests
url = "https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary', 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.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary",
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: <authorization>"
],
]);
$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.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
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.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"brand": {
"id": 123,
"name": "<string>"
},
"kpis": {
"mentions": {
"mentions": 123,
"runsWithBrand": 123,
"totalRuns": 123,
"mentionRatePct": 123,
"delta": 123
},
"avgPosition": {
"value": 123,
"delta": 123
},
"visibilityPct": {
"value": 123,
"delta": 123
},
"shareOfVoicePct": {
"value": 123,
"delta": 123
}
},
"entities": [
{
"name": "<string>",
"type": "<string>",
"mentions": 123,
"avgPosition": 123,
"visibilityPct": 123,
"shareOfVoicePct": 123
}
],
"platforms": [
{
"platform": "<string>",
"runs": 123,
"mentions": 123,
"visibilityPct": 123
}
]
}Returns a compact overview of your brand’s AI search performance. Includes KPIs (mentions, average position, visibility, share of voice), a ranked list of entities (brand + competitors), and per-platform stats. All metrics include period-over-period deltas.
Parameters
string
required
Bearer token. Format:
Bearer slat_<your-token>.integer
Number of days for the analysis window (e.g.,
7, 30, 90).string
Start of date range. ISO 8601 format (e.g.,
2026-02-01T00:00:00Z).string
End of date range. ISO 8601 format.
number
Brand ID. Optional — if omitted, uses the workspace’s default brand.
number
Filter by topic ID.
string[]
Filter by one or more platforms:
CHATGPT, PERPLEXITY, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, CLAUDE.string
Filter by ISO country code for region.
number
Filter by a single prompt ID.
number[]
Filter by multiple prompt IDs. Maximum 10 values.
Response
Returns200 OK with the overview summary.
object
required
Key performance indicators with period-over-period comparison.
Show KPIs object
Show KPIs object
object
required
object
required
object
required
object[]
required
object[]
required
Example
curl -s "https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary?dateRange=30&topicId=42" \
-H "Authorization: Bearer slat_YOUR_TOKEN"
import requests
response = requests.get(
"https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary",
headers={
"Authorization": "Bearer slat_YOUR_TOKEN",
},
params={
"dateRange": 30,
"topicId": 42,
},
)
summary = response.json()
kpis = summary["kpis"]
print(f"Mentions: {kpis['mentions']['mentions']} ({kpis['mentions']['mentionRatePct']}%)")
print(f"Visibility: {kpis['visibilityPct']['value']}%")
const params = new URLSearchParams({
dateRange: "30",
topicId: "42",
});
const response = await fetch(
`https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/overview/summary?${params}`,
{
headers: {
"Authorization": "Bearer slat_YOUR_TOKEN",
},
}
);
const summary = await response.json();
console.log("Brand:", summary.brand.name);
console.log("Entities:", summary.entities.length);
Response
{
"brand": {
"id": 5,
"name": "MyBrand"
},
"kpis": {
"mentions": {
"mentions": 120,
"runsWithBrand": 85,
"totalRuns": 200,
"mentionRatePct": 42.5,
"delta": 15
},
"avgPosition": { "value": 2.3, "delta": -0.5 },
"visibilityPct": { "value": 78.0, "delta": 3.2 },
"shareOfVoicePct": { "value": 35.5, "delta": 2.1 }
},
"entities": [
{
"name": "MyBrand",
"type": "BRAND",
"mentions": 120,
"avgPosition": 2.3,
"visibilityPct": 78.0,
"shareOfVoicePct": 35.5
},
{
"name": "CompetitorA",
"type": "COMPETITOR",
"mentions": 90,
"avgPosition": 3.1,
"visibilityPct": 65.0,
"shareOfVoicePct": 26.7
}
],
"platforms": [
{ "platform": "CHATGPT", "runs": 80, "mentions": 55, "visibilityPct": 82.0 },
{ "platform": "PERPLEXITY", "runs": 60, "mentions": 40, "visibilityPct": 75.0 },
{ "platform": "GEMINI", "runs": 60, "mentions": 25, "visibilityPct": 70.0 }
]
}
Status codes
| Status | Description |
|---|---|
200 | Overview summary returned. |
400 | promptIds exceeds maximum of 10 values. |
401 | Missing or invalid Bearer token. See Authentication. |
500 | Internal server error. |
What’s next
- Get Overview Trend — View time series trends.
- Get Citations Summary — View citation analytics.
Was this page helpful?