Skip to main content
POST
List mentions

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Body

application/json

Filter and paginate mentions. Either provide view to reuse an existing feed's filters, or supply filters directly (or both - they merge). Body shape matches v1 /api/v1/mentions so v1 clients can reuse the same request bodies. Date ranges live inside filters.startDate / filters.endDate (ISO 8601).

view
integer

Feed/view ID to reuse as a base filter. If filters is also provided, the two are merged (view's saved filters + inline filters both apply).

Required range: x <= 9007199254740991
filters
object

Filter object. Accepts the simple flat form ({ source: ["twitter"], sentiment: ["positive"] }) or the advanced group form with AND/OR operators. Use POST /api/v2/ai/filter-wizard to generate one from natural language.

includeAll
boolean
default:false

When true, includes low-relevance mentions (internal relevanceScore = 2). Default false returns only high and medium relevance (scores 0 and 1).

includeEngagementMetrics
boolean

When true, enriches each returned mention with the latest public engagement snapshot (engagementMetrics and engagementObservedAt). Default false omits those optional fields and avoids the additional Tinybird engagement-state join. This controls response enrichment only; engagement filters still work without it.

includeRelevantOnly
boolean

When true, forces relevant-only results (scores 0 and 1) even if includeAll is true. Convenience parity with the in-app feed toggle; omit to defer to includeAll.

limit
integer
default:20

Page size, 1-100.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response's pagination.nextCursor.

Free-text search. Case-insensitive substring match across the mention's title, body, author handle, and author display name. Composes with view/filters (AND semantics). Empty or whitespace-only values are ignored.

Maximum string length: 200

Response

200 response

Paginated list of mentions.

data
object[]
required
pagination
object
required