Skip to main content
GET
List / search competitors

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.

Query Parameters

q
string

Free-text search over titles and content.

granularity
enum<string>
default:week

Bucket size for each competitor's pressure series.

Available options:
day,
week,
month
date_from
string<date>

Inclusive start date (ISO 8601).

date_to
string<date>

Inclusive end date (ISO 8601).

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

200 - application/json

A page of competitors, each with a pressure time series

data
object[]
pagination
object