Skip to main content
GET
Recommend monitoring settings from search history

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Query Parameters

targetPlan
enum<string>

Plan the user is upgrading to (default Starter_v3, the entry paid tier). Plans without keyword monitoring (e.g. Agents) are rejected with TARGET_PLAN_HAS_NO_KEYWORDS.

Available options:
Individual,
Start_up,
Scale_up,
AppSumoTier1,
AppSumoTier2,
AppSumoTier3,
Free_trial,
Basic,
Pro,
Max,
Starter,
Scale,
Pro_v2,
Enterprise,
Starter_v3,
Pro_v3,
Agency,
Agents
Example:

"Starter_v3"

Response

200 response

Recommended monitoring settings (keywords, platforms, relevance-guideline hints) derived from the workspace's search history, sized for the target plan.

source
enum<string>
required

search_history when derived from the org's actual searches; domain when the history was too thin (or the model unavailable) and the company-profile fallback path answered.

Available options:
search_history,
domain
targetPlan
enum<string>
required

The plan the recommendations are sized for — keyword recommendations are capped at that plan's monthly keyword allowance.

Available options:
Individual,
Start_up,
Scale_up,
AppSumoTier1,
AppSumoTier2,
AppSumoTier3,
Free_trial,
Basic,
Pro,
Max,
Starter,
Scale,
Pro_v2,
Enterprise,
Starter_v3,
Pro_v3,
Agency,
Agents
Example:

"Starter_v3"

keywordLimit
integer
required

The target plan's monthly keyword allowance the set was capped to.

Required range: -9007199254740991 <= x <= 9007199254740991
keywords
object[]
required

Ranked best-first. Never empty; never longer than keywordLimit.

platforms
enum<string>[]
required

Recommended platforms to monitor, best-first.

Platform a mention can originate from / a keyword can be monitored on.

Available options:
dev,
github,
hackernews,
linkedin,
producthunt,
reddit,
stackoverflow,
twitter,
youtube,
tiktok,
medium,
reddit_comment,
bluesky,
newsletter,
podcasts,
news,
firehose
relevanceGuidelineHints
string[]
required

Candidate org-specific relevance guidelines distilled from search contexts. May be empty.

history
object
required

What the recommendation was computed from.