Contents

API reference / Analytics

Every brand at a glance

GET /api/v1/overview

get_overview Read MCP tool

One row per project for the period: mentions and the change on the period before, the sentiment split, mentions per day, the top source, the brand's share of mentions against its competitors, when it was last scanned, and how many mentions are open or parked for follow-up (over all time). `total` is everything the tracked keywords matched (brand, competitors and topics together); `brand`, `brand_*` (previous period, sentiment, top source, daily) are the brand's own mentions, and `competitors` and `topics` are the rest. Use it to compare brands; get_analytics goes deep on one.

Any API key or OAuth token, or a signed-in member.

Parameters

NameTypeDescription
since
query
string ISO date/time or epoch ms.

Returns

{ data: { since, previous_since, projects: [{ id, name, total, previous, positive, neutral, negative, open, follow_up, top_source, brand, competitors, topics, brand_previous, brand_positive, brand_neutral, brand_negative, brand_top_source, brand_daily, daily, last_scan }] } }

Example

curl "https://sniffington.com/api/v1/overview" \
  -H "Authorization: Bearer $SCOUT_API_KEY"