Contents

API reference / Analytics

Break mentions down by one dimension

GET /api/v1/analytics/breakdown

get_breakdown Read MCP tool

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

Parameters

NameTypeDescription
project
query
string Project id.
sources
query
array of string Sources to search. Omit for every source available.
One of: reddit linkedin x hn instagram github stackoverflow devto bluesky news youtube tiktok threads
groups
query
array of integer Keyword group ids.
keywords
query
array of integer Keyword ids.
categories
query
array of integer Category ids.
sentiment
query
array of string Sentiment.
One of: positive negative neutral
since
query
string ISO date/time or epoch ms.
until
query
string ISO date/time or epoch ms.
include
query
string relevant (default): real mentions. irrelevant: filtered out as namesakes or noise.
One of: relevant irrelevant all
by
query
string
One of: source sentiment status category keyword group place author project

Example

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