Sign in

v1

latestOpenAPI 3.0.02026-07-223589127.1 KB
Monitors

Create monitor

Create a recurring monitor that runs on a schedule and stores matching events for later review.

post/api/v1/monitors

Request body

namestring required

Human-readable name

type'linkedin_keyword' | 'linkedin_profile' | 'linkedin_company' | 'linkedin_post' | 'instagram_profile' | 'instagram_post' | 'x_profile' | 'x_keyword' | 'reddit_keyword' | 'reddit_subreddit' | 'tiktok_keyword' | 'tiktok_hashtag' | 'web_search' | 'site_search' required

Monitor type

configobject required

Type-specific configuration (query, filters, etc.)

cadence_minutesnumber

Cadence in minutes (minimum 60 for scraper-based types: LinkedIn, Instagram, X, Reddit, TikTok; minimum 15 for web)

max_resultsnumber

Max results per run (1-100)

force_freshboolean

Force fresh scrape bypassing cache

cache_ttl_daysnumber

Cache TTL in days for profile/company monitors (1-90)

post_urlstring

LinkedIn post URL (required for linkedin_post type)

Example request

{
  "name": "Competitor mentions",
  "config": {
    "query": "hiring engineers",
    "max_results": 20
  }
}

Response

Monitor created.

idstring required
namestring required
type'linkedin_keyword' | 'linkedin_profile' | 'linkedin_company' | 'linkedin_post' | 'instagram_profile' | 'instagram_post' | 'x_profile' | 'x_keyword' | 'reddit_keyword' | 'reddit_subreddit' | 'tiktok_keyword' | 'tiktok_hashtag' | 'web_search' | 'site_search' required
status'active' | 'paused' | 'disabled' required
configobject required
cadence_minutesnumber required
last_run_atstring nullable required
next_run_atstring nullable required
consecutive_failuresnumber required
created_atstring required
updated_atstring required