Skip to main content

​
Alert

Represents a Mention alert that monitors specific keywords and sources.
​
id
string
required
Unique identifier for the alert
​
name
string
required
Display name of the alert
​
query
object
required
Alert query configuration
​
languages
array
default:"[]"
List of language codes to monitor (e.g., [“en”, “fr”, “es”])
​
countries
array
default:"[]"
List of country codes to filter by (e.g., [“US”, “GB”, “CA”])
​
sources
array
default:"[]"
List of sources to monitor
​
noise_detection
boolean
default:"true"
Whether to enable noise detection filtering
​
sentiment_analysis
boolean
default:"true"
Whether to enable sentiment analysis
​
mentions_count
integer
default:"0"
Total number of mentions for this alert
​
unread_mentions_count
integer
default:"0"
Number of unread mentions
​
shares_count
integer
default:"0"
Number of times this alert has been shared
​
followers_count
integer
default:"0"
Combined follower count from all mentions
​
reach
integer
default:"0"
Estimated total reach across all mentions
​
last_mention_at
string
ISO 8601 timestamp of the most recent mention
​
created_at
string
ISO 8601 timestamp when the alert was created
​
updated_at
string
ISO 8601 timestamp when the alert was last updated

​
QueryType Enum

Available query types for alerts:
  • basic - Simple keyword matching
  • advanced - Advanced search with boolean logic
  • boolean - Full boolean query support

​
AlertSource Enum

Available source types:
  • web - General web sources
  • twitter - Twitter/X mentions
  • facebook - Facebook posts
  • instagram - Instagram posts
  • youtube - YouTube comments and videos
  • reddit - Reddit posts and comments
  • news - News articles
  • blog - Blog posts
  • forum - Forum discussions
  • review - Product reviews

​
Example

{
  "id": "alert_1234567890",
  "name": "Brand Mentions",
  "query": {
    "type": "basic",
    "included_keywords": ["MyBrand", "My Brand"],
    "excluded_keywords": ["spam", "advertisement"],
    "required_keywords": [],
    "should_belong_to_owner": false
  },
  "languages": ["en", "es"],
  "countries": ["US", "MX"],
  "sources": ["web", "twitter", "news"],
  "noise_detection": true,
  "sentiment_analysis": true,
  "mentions_count": 1847,
  "unread_mentions_count": 23,
  "shares_count": 5,
  "followers_count": 45000,
  "reach": 250000,
  "last_mention_at": "2026-03-04T08:15:00Z",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2026-03-04T08:00:00Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us