Rumoro

Deletes an outreach activity that was logged by mistake. The person keeps the same owner and stage.

Deletes an alert. Its channels remain and other alerts can use them. This cannot be undone. To keep the alert, disable it with update_alert enabled=false instead.

Deletes a keyword group and all of its keywords, each as delete_keyword would, mentions included. The default group cannot be deleted. The answer says how many keywords were deleted.

Stops monitoring a keyword and deletes its mentions, but keeps a post that another keyword also matched. Alerts that named it drop it, and an alert that named only this keyword is disabled instead of widening to all keywords. This cannot be undone. Muting with update_keyword muted=true keeps the mentions.

Deletes a saved segment. The people in it are not changed.

Deletes a saved view and leaves its mentions untouched.

Tells your workspace that two accounts are the same individual by merging account `id` into person `into`. Their mentions, tags and notes are combined, and the merged account appears among the person's platforms.

Creates a keyword to track. kind is "brand" (default), "competitor" or "topic". platforms limits where it runs, all by default. New posts with the term are matched, classified and delivered. To narrow a common word, set `matching` (requiredTerms with requiredMode any or all, excludedTerms with a `*` wildcard at either end, excludedAuthors, caseSensitive). Rejected posts are never stored or billed. `context` is one sentence for this keyword's classifier, such as "Basil is our deploy tool, not the herb." `cap` ({ mentions: N }) sets a monthly limit on matches. A capped keyword stops matching until the 1st (UTC) or a higher cap, and is still charged daily. `groupId` picks a group from list_groups, otherwise the default group. A term can exist once per group. `reviewSources` adds review pages, each as a url (App Store or Google Play app, Trustpilot page, Google Maps place or maps.app.goo.gl link) or a platform (appstore, googleplay, trustpilot, googlemaps) and id. App stores also take countries (two-letter, default us), and Google Play a language (default en). Every review becomes a mention, pages are read daily, and the last 30 days (up to 100 reviews) arrive free at once. `feeds` reads RSS or Atom feeds, each as { url }: a feed's address, or a page's (a forum, a community, a blog) whose advertised feed is used; an address with no feed is refused. An item is a mention when it holds the term, feeds are read every hour, and the newest 10 matching items of the last 30 days arrive at once, billed like any mention. `platforms: []` makes a reviews-only or feeds-only keyword. `comments` ({ enabled: true, maxPerPost: N }, off by default) reads the comments under its relevant mentions from 30 minutes after each post while its platform's conversations last, at most maxPerPost (default 20) per mention, $0.008 per comment delivered; list them with list_mention_comments.

Creates an alert. mode "instant" sends each matching mention as it arrives. "hourly" sends a digest of the previous UTC hour at five past, skips hours with no mention above the minimum, and takes no schedule and no email channel (only Slack, Telegram and webhooks). "daily" sends one digest at schedule.hour in schedule.timezone. "weekly" sends one a week on schedule.weekday, from 0 for Sunday to 6 for Saturday. filter can use keywordIds, platforms, minRelevance, minConfidence, sentiments, intents, excludeAuthors, minFollowers, tags and linkHosts (hosts a post links to, including subdomains). Without minRelevance only relevant mentions (40 and up) are sent, and 0 sends every scored match, noise included. channelIds come from list_channels.

Creates a keyword group with a name that is unique in the workspace. You can add externalId, your own unique id such as a client id. You can also add context, a company description saying who the business is, what it sells and to whom. The classifier reads it instead of the whole workspace profile, guidelines and competitors included, for this group's keywords, so put any group rule in that text. An agency can make one group per client with the client's description, so each client's mentions are scored for that client. Then pass the group's id as groupId to add_keyword.

Saves an audience segment with a name and a filter. The filter can use platforms, tags, follower range, minimum mentions or negative mentions, intents, keyword kinds the person did or did not mention, first seen within N days, and linkHosts they linked to. Members are worked out on each read, not stored.

Saves a view with a name and a filter. The filter uses the fields of search_mentions, such as keywords or keyword kinds, platforms, status, relevant, sentiments, intents, languages, author tags, follower range, replies, link hosts, automated and free text. A list matches any value, a `not` list matches none, and all conditions are joined by AND. anyOf adds OR with groups of such conditions, at least one of which must match. Nothing is stored ahead of time, so the view shows whatever matches when read.

Moves an attention item (att_... from list_attention) out of the open list for as long as its condition lasts.

Creates a new keyword with an existing keyword's settings. Give the new term, or the same term with another groupId, since a group tracks a term once. It copies the kind, platforms, context, every matching rule, the monthly mention cap and the comments setting. Review pages and feeds are copied only when listed in include (reviewSources, feeds), because two keywords on one page collect and bill every review twice. The copy is a new keyword: $5 a month, and its last 30 days come in at once.

The comments under a mention's post, newest first, whether or not each names your keyword, with a light sentiment and intent read and mentionId when a comment is itself one of your mentions. Filled for new relevant mentions of keywords with comments on, from 30 minutes after the post.

Logs that someone on the team contacted a person, for example by email, direct message or call. A not_contacted person moves to contacted, and a person with no owner gets the contacting member as owner. A later stage or an existing owner stays, and update_person changes them. memberId falls back to the signed-in user. Called with an API key and no memberId, it logs an activity without a member and sets no owner. Returns the new activity and the updated person.

Adds authors to an alert's muted list and keeps the rest of the filter. Entries can be profile or post links, @handles, u/names, Bluesky DIDs or display names. Links are stored as the author's profile. Authors already on the list are skipped, and entries that don't name a person are refused.

Reverses a merge, so the account is a separate person again in your workspace.

Takes authors off an alert's muted list and keeps the rest of the filter. Each entry can be the stored value or a link to the person's profile or posts. Authors not on the list are skipped.

Changes an alert's name, enabled, mode, schedule, filter or channelIds. filter and channelIds are replaced in full.

Changes the company profile (name, description, useCases, accounts) or sets the classifier context yourself. Profile changes rebuild the context, and a context you set applies until the next profile change. The context affects relevance scores more than anything else, so keep it accurate and specific. It does not apply to keywords in a group with its own description, which you change with update_group. Fields you leave out stay as they are.

Changes the workspace filters. These are excludedTerms (`*` at either end is a wildcard), excludedAuthors (links, handles or names), excludedRepos (owner/name or a github.com link), subreddits.only (allowed subreddits, and when set, excluded is ignored) and subreddits.excluded. Every list is optional. A list you leave out stays as it is, and an empty list clears it. New mentions follow the change within a minute.

Changes a keyword group's name, its externalId or its company description in context. Null clears externalId. Null clears context too, so the workspace profile applies again, and new mentions use the change right away. The default group can be renamed but takes no description, because it is the workspace itself and uses the company profile (update_company).

Changes a keyword. You can rename it with term: the new term is tracked from now on, with no look-back, and the keyword keeps its id, settings and what the old term found. You can set its platforms (a list, or null for all), mute or unmute it, change its kind, or set its classifier context (null clears it). You can change its matching rules, where each field is optional and an empty list clears it, with requiredTerms and requiredMode any or all, excludedTerms with a `*` wildcard at either end, excludedAuthors and caseSensitive. You can set its monthly cap with cap: { mentions: N }, where null removes it and a cap above this month's count resumes a capped keyword right away. You can move it with groupId, which returns 409 if that group already has the term. You can set reviewSources, the full list of App Store, Google Play, Trustpilot or Google Maps pages, where an empty list disconnects them and a newly added app or country brings its last 30 days free. You can replace the RSS or Atom feeds it reads with feeds, the whole list of { url }, where an empty list disconnects them and a newly added feed brings its newest 10 matching items of the last 30 days. You can switch comments on or off with comments ({ enabled, maxPerPost }; $0.008 per comment delivered). Rules only affect new mentions. Returns the keyword after the change, with its stats.

The only way to change a mention. Set status to "ignored" when it is not interesting, "done" when handled, or "open" to reopen it. Assign it with assigneeId, or null to remove the assignment. Hide it from the feed until an ISO 8601 time with snoozedUntil, or null to bring it back. Add a team note with note, or null to remove it. Correct the classifier with `relevant`, where true or false sets relevance to 100 or 0 and moves the mention into or out of the relevant feed, and null removes your judgment. `sentiment` sets the label, and null brings back the classifier's. Use these corrections when the user says a mention is noise or was missed. Fields you leave out stay as they are. Delivery and billing never change.

Changes your workspace's details on a person. You can set their full tag list, notes, mute, the outreach owner (ownerId, a member's user id, or null to remove) and stage. Muting hides their posts from the feed and all channels. Collection and billing do not change.

Changes a saved segment's name, description or filter. `filter` sets the full new filter.

Changes a saved view's name, description or filter. `filter` sets the full new filter.

Fetches an alert by id. Includes delivery stats as well as its filter, mode, schedule and channels.

Returns a table grouped by `by`. That is platform, keyword, sentiment, intent, status (open, ignored, done), hour (weekday and hour in timezone, to see when people post) or person (the most active authors, with followers). Each row has matched, relevant, its percentage of the period, a sentiment split and, with compare=true, the same row for the period just before. The period works as in get_analytics_summary. Up to 50 rows, the one with the most matches first.

Counts matched, relevant and sentiment mentions per day or week (bucket, days by default up to 90 days). Returns one "total" series, or splits by="platform" or by="keyword" (top 20, rest as "other"). Period options match get_analytics_summary. compare=true adds `previous`, the prior period, aligned by index.

Returns summary counts for a period. Covers matched and relevant mentions, unique posts and people, sentiment, buying intent, questions, reach and triage. Reach sums followers where known. Triage gives open, ignored and done counts, mentions waiting over 24h, handled rate and median time to done. Set the period with range (7d, 30d, 90d or 365d, ending today) or from and to (YYYY-MM-DD). keywordIds and platforms take lists. timezone (IANA, default UTC) sets day boundaries. compare=true adds the prior period as `previous`. Dates are publish dates.

Returns the company profile the classifier reads, with name, description, use cases, own accounts and the context text built from them for relevance scoring. A group with its own description replaces that text for its keywords (see list_groups).

Returns the workspace noise rules that run before any mention is stored, for every keyword. They exclude terms, authors and GitHub repositories, and allow or block subreddits. Rejected posts are never classified, sent or billed. Keywords add their own `matching` rules.

Returns a keyword group by id, with its number of keywords.

Fetches a keyword by id. Returns its setup (term, kind, platforms, matching rules, context, monthly cap, pausedForCap), its stats and how polling goes on each platform.

Checks whether a keyword earns its cost, over range 7d, 30d or 90d (default 30d). Returns a status with plain-word reasons. noisy is 20+ scored matches with under 30% relevant, quiet is 7+ days old with nothing relevant, new is under 7 days old, and the rest are healthy, capped or paused. Also returns matches, relevant and noise share by platform and week, cost, the words and authors behind the noise, and suggestions. To apply one, pass its `patch` and the keyword id to update_keyword (lists replace the whole list). Its `effect` shows the noise and relevant matches and the cents the matcher's rules say it would have removed in the period. ai=true adds a model-written context (cached a day, 20 calls an hour per workspace). Read only, never billed, cached 5 minutes.

Fetches one mention, classification included (relevance, sentiment, intents, confidence, uncertain, note).

Returns mention counts for the past N days (7 by default), by platform and by sentiment. You can limit it to one platform or keyword. Mentions without a score are counted under the sentiment "unclassified".

Returns one person from your audience with their counts, your tags, notes and mute, and their outreach status (owner, stage, last contacted). It also has their public profile where the platform shows one, with bio, company, location, website and linked accounts. profile.email is always null here. GitHub authors are looked up the same day, and profile is null until then.

Reports on the reviews your keywords collect from the App Store, Google Play, Trustpilot and Google over a period. Includes totals (reviews, average stars, star distribution, replies, open 1 and 2 star reviews), tags from unhappy reviews, and each review page's average stars per day or week (bucket). Two keywords matching one review count it once. Period options match get_analytics_summary, and compare=true adds the prior period.

Compares your brand with competitors. Returns each keyword with matches in the period, with matched, relevant, negative and buy-intent counts and its percentage of all brand and competitor matches. Topics are counted but not part of the split. The period works as in get_analytics_summary. compare=true adds each keyword's matches for the period just before.

Shows whether tracking is stopped or the balance is low, with the prepaid balance (ledger, pending mention charges, effective), daily spend and days left, running and balance-paused keywords, and matches today and over 30 days. Pricing is $0.008 per matched mention and $5 a month per active keyword, charged daily.

Usage and charges for a period in US cents at list price, grouped by one `by` per call. keyword (default) gives days charged, mentions billed and totalCents per keyword, with deleted keywords marked keyword.removed=true. platform and day also work. Pick a trailing `range` (7d, 30d or 90d, default 30d) or a calendar `month` (YYYY-MM), which matches a bill or a per-client margin. Every call includes totals (keyword-days, matched and billed mentions, list-price total, actual ledger debits). Rows are paged (limit, offset, total). Use it for "what did keyword X cost". get_usage tells how much is left, and get_keyword has each keyword's month-to-date cost as stats.cost.

Shows who on the team has contacted a person, latest first. Each entry has the member, the channel, the time and a note. Channels are email, x, linkedin, bluesky, reddit, github, call, meeting and other. Look at this and the outreach owner before contacting someone, so teammates don't double up.

Returns every alert with its filter, mode, schedule and channels. The mode is instant, or hourly, daily or weekly for a digest.

Lists items that need a person, latest first. Kinds are mention.spike (mentions jumped in the last hour), sentiment.negative_spike (24-hour negative share jumped), keyword.noisy (turned noisy) and channel.failing (recent sends all failed). Checks run hourly, and items resolve when the condition ends. Open items by default, and status "all" adds the history. Items have a one-line title, numbers in data, and data.url to the dashboard.

Lists alert destinations (Slack channels, Telegram chats, email lists, webhooks). Connect Telegram chats in the dashboard under Settings, Integrations. The API can't.

Lists the workspace's keyword groups, the default first. Groups organize keywords, for example by client, campaign or product. Every keyword is in one group, a group can hold a term once, and get_usage_breakdown with by=group shows each group's cost. externalId finds the group with your own id.

Lists the workspace's keywords with stats, polling status, matching rules and context, plus `total`. With no arguments you get all keywords, latest first. q searches the term and context. You can filter by kind, status (active, muted by someone, paused for balance, noisy when the noise brake paused it, or capped at its monthly mention cap), platform or groupId, order with sort, and page with limit and offset.

Shows the prepaid balance's history, latest first. Entries cover the welcome credit, top-ups, refunds, adjustments, and the daily keyword-day and mention debits. Debits carry their UTC settlement day and cumulative units. Cursor pages, limit up to 100. Funds are added on the dashboard's billing page or with POST /v1/billing/top-ups.

Lists workspace members with their role (owner, admin, member), email and user id. Use the user id for assigneeId in update_mention and ownerId in update_person.

Lists the authors of mentions of your keywords. Each has name, profile, platform, how many posts matched and how many scored relevant, sentiment split, first and last seen, and outreach status (owner, stage, last contacted). You can filter by platform or name, find one person by handle or profile link (handle), and filter by outreach stage (stages), owner (ownerIds, or "none" for no owner) or automated (bots whose posts are mostly machine-made). Sort by mentions or by recency. To read what one person said, use search_mentions with personId.

Lists your saved audience segments, which are named people filters such as "Large accounts" or "Open to switching", with the current number of people in each. Also returns presets you can save with create_segment. To see who is in a segment, pass its id to list_people.

Lists your saved views, which are named mention filters such as "Bug reports" or "Waiting on us". Pass a view's id as viewId to search_mentions to get exactly what it shows.

Searches the workspace's mentions. You can filter by keyword, platform, status (open, ignored, done), relevant, minimum relevance, minimum confidence (0 to 1), sentiment, intent, text (q, in the post or the author's name) and time range (ISO 8601). You can also filter by one person (personId from list_people), assignee (assigneeId), author followers (minFollowers, maxFollowers), engagement counts from the platform (minLikes, minReposts, minReplies, minQuotes, minViews, minBookmarks, where posts without that count are left out), review stars (ratings, or notRatings to exclude some), author tags (tags, any of them), linked hosts (linkHosts, a host or its subdomains), replies or not (isReply), and machine-made posts (automated true or false). alertId applies an alert's whole filter, giving the mentions it would send. viewId applies a saved view from list_views on top of the rest. keywordKinds filters by the kind of keyword that matched (brand, competitor, topic), and groupIds or notGroupIds by the keyword's group (ids from list_groups). All filters are joined by AND. For OR, anyOf takes up to 10 groups of the same conditions, each an object whose conditions are joined by AND, and keeps a mention when one group matches as well as the rest. For example anyOf=[{platforms:["github"],intents:["bug_report"]},{sentiments:["negative"]}]. Snoozed mentions are hidden unless snoozed=true. sort is "newest" (the default) or "priority", an attention score built from relevance, author reach, intent and age that covers only the past 30 days of matches and comes on each mention as `priority`. Returns 10 mentions by default, up to 100 with limit. Each mention contains post, author, classification and triage.

Returns the workspace this credential works in, the kind of credential (an API key or an OAuth sign-in), whether it can write, and the signed-in user if there is one. Call it once when a session starts, to name the workspace and learn whether write tools will work.