Skip to main content
GET
Count mentions

Authorizations

x-api-key
string
header
required

API key created from the Nephia dashboard for your Account.

Query Parameters

since
string<date-time>

ISO-8601 lower bound, inclusive, on the date the mention was published (the collection date where the Source gives none), which is how Insights counts. Defaults to 7 days before until.

until
string<date-time>

ISO-8601 upper bound, inclusive, on the same date. Defaults to now. The window covers 90 days at most.

group_by
string
required

One or two axes, comma-separated: day, hour, source, sentiment, intent, author, term, query. day and hour cannot be combined.

Example:

"day,sentiment"

top
integer

How many values of an open axis (author, term, query) to keep, busiest first. Default 10, at most 50.

Required range: 1 <= x <= 50
kind
enum<string>
Available options:
polling,
runs
source
Available options:
x,
reddit,
youtube,
tiktok,
bluesky,
hackernews,
mastodon,
lemmy,
github,
producthunt,
stackoverflow,
rss,
ai_answers,
vinted
query
string<uuid>

Only this Query's mentions, by id from GET /v1/queries, including what its searches caught before they last changed. An id that is not one of your Queries is a 404.

intent
Available options:
purchase_intent,
comparison,
question,
complaint,
praise,
other,
unread
sentiment
Available options:
positive,
neutral,
negative,
question,
mixed,
unread
author
Required string length: 1 - 200
engagement_min
integer
Required range: x >= 0
engagement
Required string length: 1 - 120

Response

Counts

since
string
required
until
string
required
total
integer
required
groupBy
enum<string>[]
required
Available options:
day,
hour,
source,
sentiment,
intent,
author,
term,
query
rows
object[]
required
unread
integer | null
required
truncated
boolean
required