Mentions per day by source, project, sentiment, category or group
GET /api/v1/analytics/volume
A daily count of mentions, split by one dimension, for charting volume over a period.
Any API key or OAuth token, or a signed-in member.
Parameters
| Name | Type | Description |
|---|---|---|
projectquery |
string | Project id. |
sourcesquery |
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 |
groupsquery |
array of integer | Keyword group ids. |
keywordsquery |
array of integer | Keyword ids. |
categoriesquery |
array of integer | Category ids. |
sentimentquery |
array of string | Sentiment. One of: positive negative neutral |
sincequery |
string | ISO date/time or epoch ms. |
untilquery |
string | ISO date/time or epoch ms. |
includequery |
string | relevant (default): real mentions. irrelevant: filtered out as namesakes or noise. One of: relevant irrelevant all |
tierquery |
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_passingquery |
boolean | Leave out the passing mentions: posts that name the tracked word and say nothing worth acting on. Off by default. |
author_kindquery |
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_botsquery |
boolean | Leave out posts by bot or spam accounts. Off by default. |
hide_companiesquery |
boolean | Leave out posts by company accounts promoting themselves. Off by default. |
byquery |
string | One of: source watcher sentiment category group |
Example
curl "https://sniffington.com/api/v1/analytics/volume" \
-H "Authorization: Bearer $SCOUT_API_KEY"