Skip to main content
POST
Create monitor

POST /api/v1/monitors

Create a recurring monitor to track keywords, profiles, or posts.
Create a monitor that runs on a schedule to track keywords, profiles, or posts across LinkedIn, X, Reddit, TikTok, Instagram, and the web.

Example

Authorizations

X-Access-Key
string
header
required

The public API key from the Credentials page.

X-Secret-Key
string
header
required

The API secret shown when the credential is created.

Body

application/json
name
string
required

Human-readable name

Example:

"Competitor mentions"

type
enum<string>
required

Monitor type

Available options:
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
config
object
required

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

Example:
cadence_minutes
number
default:60

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

max_results
number
default:10

Max results per run (1-100)

force_fresh
boolean
default:false

Force fresh scrape bypassing cache

cache_ttl_days
number
default:14

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

post_url
string

LinkedIn post URL (required for linkedin_post type)

Response

Monitor created.

id
string
required
name
string
required
type
enum<string>
required
Available options:
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
status
enum<string>
required
Available options:
active,
paused,
disabled
config
object
required
cadence_minutes
number
required
last_run_at
string | null
required
next_run_at
string | null
required
consecutive_failures
number
required
created_at
string
required
updated_at
string
required