Skip to main content
GET
Get Overview Summary
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). Range: 1–365. Default: 30.
string
Start of date range. RFC 3339 timestamp (e.g., 2026-02-01T00:00:00Z). Send together with to.
string
End of date range. RFC 3339 timestamp. Send together with from. Data through the end of this date (UTC) is included. The range can’t exceed 366 days.
number
Brand ID. If omitted, uses the brand of the workspace’s most recently updated prompt.
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 500 values.

Response

Returns 200 OK with the overview summary.
object
required
Brand reference.
object
required
Key performance indicators with period-over-period comparison.
object[]
required
Ranked list of brands and competitors.
object[]
required
Per-platform performance breakdown.

Example

Response

Status codes

What’s next