Dashboard
Brands Overview
Get the organization-wide ‘All Brands’ portfolio overview — per-brand health plus org KPIs.
GET
Retrieve the All Brands portfolio overview for one of the organizations the authenticated user belongs to. It returns a per-brand snapshot (AI visibility, domain rating, open next steps, tracked prompts/keywords, and Search/Traffic) alongside a few organization-level KPIs.
The response is read from the persisted daily snapshot (
brandDailyStats), so it is fast and does not trigger live provider fan-out. To force a fresh recompute, call POST /v3/organization/portfolio/refresh.
Query parameters
Deltas & sparklines
- Point metrics (AI visibility):
deltais the absolute change of the latest in-window value vs. the prior equal-length window. - Count metrics (search clicks, traffic visits):
deltais the percentage change of the window sums. - Sparklines are the daily series across the selected window.
Top-level fields
kpis
brands[]
Metrics come from the persisted daily snapshot. If a brand has no data yet for the window (no audit, no AI visibility runs, or a disconnected integration), the relevant metric returns
null (search, traffic, domainRating) or 0 (counts), and sparklines return empty or partial series.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Organization ID (from list_teams). Optional when the user belongs to a single org.
Window start date (YYYY-MM-DD, UTC). Defaults to 30 days before end.
Window end date (YYYY-MM-DD, UTC). Defaults to today.
Response
200
Default Response

