Keywords

Check a keyword's health

Checks whether the keyword earns its cost over range (default 30d). Returns a status (healthy, noisy, quiet, capped, paused or new) with plain-word reasons, numbers by platform and week, cost, the words and authors behind the noise, and suggestions. Send a suggestion's patch unchanged to PATCH /v1/keywords/{id}. Its effect comes from replaying the matcher's rules on the window's posts. ai=true adds a model-written context (cached a day, up to 20 model calls an hour per workspace). Read only and never billed. Reports are cached 5 minutes and rebuilt after a keyword change. Up to 30 reads a minute per workspace.

get/v1/keywords/{id}/health

Request

  • Base URL: https://api.rumoro.dev
  • URL: https://api.rumoro.dev/v1/keywords/{id}/health
  • Auth: HTTP bearer

Path parameters

idstring required

The keyword's id (kw_...).

Example:kw_abc123

Query parameters

range'7d' | '30d' | '90d'

How many UTC days back from today to read, by match time. One of 7d, 30d or 90d, 30d by default.

aiboolean

true also asks a language model to rewrite the context. The answer is cached for a day per keyword and window, with at most 20 model calls an hour per workspace. With the default false, all suggestions come from the rules only.

Response

The health report for the keyword

status'healthy' | 'noisy' | 'quiet' | 'capped' | 'paused' | 'new' required

The first that applies wins. paused when you, the wallet or the noise brake muted it. capped at the monthly mention cap. noisy with 20+ scored matches in the window and under 30% relevant. new when under 7 days old, or changed in the last 7 days with under 20 scored matches since. quiet when 7+ days old with nothing relevant in the window. Otherwise healthy. After a rules, platforms or context change, or an unmute, inside the window, only later matches count (stats.judgedSince).

reasonsstring[] required

Plain-word explanation, status first.

generatedAtstring required

When the report was built. Reports are cached for 5 minutes, and changing the keyword builds a new one.

Changes

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