Skip to main content
GET
Search competitor mentions

Authorizations

X-API-Key
string
header
required

Team-scoped API key created in the app (Settings → API Keys). Sent as X-API-Key: <key> on every request. The header name apikey is also accepted as an alias.

Query Parameters

q
string

Free-text search over titles and content.

competitor
string

Filter by competitor: id or name.

customer_id
string<uuid>

Filter to mentions from one customer.

date_from
string<date>

Inclusive start date, as a real calendar date in YYYY-MM-DD. Any other form is rejected with 400 VALIDATION_ERROR - including 2026-5-1, 2026/05/01, May 1, 2026, a bare 2026, a date-time, and impossible dates such as 2026-02-30.

Pattern: ^\d{4}-\d{2}-\d{2}$
date_to
string<date>

Inclusive end date, as a real calendar date in YYYY-MM-DD. Validated by the same rule as date_from.

Pattern: ^\d{4}-\d{2}-\d{2}$
limit
integer
default:50

Page size (max 200).

Required range: 1 <= x <= 200
offset
integer
default:0

Number of records to skip.

Required range: x >= 0

Response

A page of competitor mentions

data
object[]
pagination
object