Email Me When a Profile Goes Viral

Creates a viral alert: we watch a TikTok, Instagram or YouTube profile and email the address you give when it publishes a post whose outlier score (views divided by the profile's own average) reaches minOutlierScore (default 3, minimum 1.5) within postAgeDays of posting (default 7, max 30). Identify the profile by profileId, platform+handle, or a public URL; it must already be in the database (crawl_profile it first if not). Setting up, listing and deleting alerts is free. Two things cost credits: the refresh crawl that keeps the profile fresh (10 credits per run, daily by default, started for you if you are not already monitoring the profile with track_profile) and each alert email actually sent (5 credits). Limits: one alert email per destination address per day, sent around sendHour in your timezone (defaults 9, UTC) and bundling every alert that fired; 3 emails per alert in total, after which the alert ends; expiresInDays (default 30, max 90) ends it regardless; 25 active alerts per account. A post can trigger an alert only once. Your account email needs no confirmation; any other address receives a confirmation link first and nothing is sent until it is clicked. Every alert email has its own stop link. Calling again for the same profile and address updates the settings instead of creating a duplicate.

Cost: free.

post/api/v1/alerts

Request

  • Base URL: https://viraloutliers.com
  • URL: https://viraloutliers.com/api/v1/alerts
  • Auth: HTTP bearer

Request body

emailstring required

Destination address. Your account email needs no confirmation; any other address gets a confirmation link first.

profileIdstring

Internal profile id from search results.

platformstring

"tiktok" | "instagram" | "youtube" (pair with handle).

handlestring

Public handle, without @ (pair with platform).

urlstring

Public profile or post URL identifying the profile.

minOutlierScorenumber

Trigger at this outlier score or above (default 3, minimum 1.5).

scoreWindowstring

Profile average the score is measured against: one_week, two_weeks, one_month, three_months (default), six_months, one_year, all_time.

postAgeDaysnumber

Only posts published within this many days can trigger (default 7, max 30).

expiresInDaysnumber

The alert ends after this many days (default 30, max 90).

sendHournumber

Preferred hour of day for the email, 0-23 (default 9).

timezonestring

IANA timezone for sendHour, e.g. Europe/Brussels (default UTC).

frequencystring

"daily" (default) | "every_3_days" | "weekly": refresh cadence when this alert starts the tracking.

Response

Success

object required

Changes

No recorded changes to this operation across all 1 revision of this API.