List Notifications
Query Parameters
string
Filter for unread notifications only (true or false)
Response
Notification[]
Array of notification objects
Example Request
Example Response
Mark Notification as Read
Path Parameters
string
required
Notification ID
Response
Notification
The updated notification object
Example Request
Example Response
Errors
- 404 Not Found - Notification not found or user doesn’t own it
Mark All as Read
Response
boolean
Returns true if successful
Example Request
Example Response
Get Notification Settings
Response
NotificationSettings
The notification settings object
Example Request
Example Response
Update Notification Settings
Request Body
string
Email frequency: daily, weekly, or none
boolean
Whether to alert on visibility drops
boolean
Whether to alert on new mentions
boolean
Whether to alert on sentiment shifts
boolean
Whether to alert on new competitor mentions
string | null
Webhook URL for real-time alerts (Growth plan only, set to null to disable)
Response
NotificationSettings
The updated settings object
Example Request
Example Response
Webhook alerts are only available on the Growth plan. Setting a webhook_url on lower plans will be ignored.