Contents

API reference / Analytics

Break mentions down by one dimension

GET /api/v1/analytics/breakdown

get_breakdown Read MCP tool

Counts of mentions grouped by source, sentiment, status, category, keyword, group, place, author or project, for the filters given.

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 facebook appstore feeds jobs pages
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
tier
query
array of string How much a kept post is worth reading: priority (urgency 50+), read, or passing (urgency under 20 and the AI's note says nothing was said about it). Every kept post is in the default results; use this to look at one tier.
One of: priority read passing
hide_passing
query
boolean Leave out the passing mentions: posts that name the tracked word and say nothing worth acting on. Off by default.
author_kind
query
array of string Who wrote the post: a person, a company promoting itself, or a bot or spam account. unknown: nobody has said (older posts, and posts the chat model judged). Bots are ruled out, so they show under include=irrelevant or all.
One of: person company bot unknown
hide_bots
query
boolean Leave out posts by bot or spam accounts. Off by default.
hide_companies
query
boolean Leave out posts by company accounts promoting themselves. Off by default.
by
query
string
One of: source sentiment status category keyword group place author project tier

Example

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