Skip to main content
POST
Create a new keyword monitor.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Monitor configuration

Request body for creating a new keyword monitor

name
string
required

Display name for the monitor

keywords
string[]
required

List of keywords to track across platforms

platforms
string[]
required

Platforms to monitor: reddit, hackernews, linkedin, x, quora, chatgpt, google_ai

filters
object

Platform-specific filters: subreddits, hnTags, chatgptPrompt, aiFilterInstructions, and negativeKeywords (list of terms that exclude a post when matched as whole words)

aiFilterEnabled
boolean

Use AI to filter relevance (default: true)

notifyEmail
boolean

Send email notifications for new mentions (default: true)

notifyInApp
boolean

Send in-app notifications (default: true)

notifyUserIds
string[]

List of user IDs to receive notifications

syncToListId
string

Smart list ID to sync mentions to automatically

Response

The created monitor

Monitor creation response

success
boolean

Whether creation succeeded

monitor
object

The created monitor