Keywords

Duplicate a keyword

A new keyword with this one's settings and a new term (or the same term in another group): its kind, platforms, context, every matching rule, its monthly mention cap and its comments setting. Review apps and feeds are copied only when listed in include. It is a new keyword: $5 per month, and the newest posts of the last 30 days come in at once, as with any new keyword.

post/v1/keywords/{id}/duplicate

Request

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

Path parameters

idstring required

Keyword id (kw_...).

Example:kw_abc123

Request body

termstring required

The term of the copy. The same term as the original only in another group (groupId): a term is tracked once per group. Wrap it in double quotes for the exact phrase only.

groupIdstring

The group of the copy (grp_...); omit for the original's group.

includestring[]

Also copy these: reviewSources (its review apps) and feeds (its RSS or Atom feeds). Off by default, since two keywords on one app or feed collect, and bill, every review or item twice.

Response

The new keyword

idstring required

Keyword id (kw_...).

termstring required
kind'brand' | 'competitor' | 'topic' required
mutedboolean required

Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).

pausedForBalanceboolean required

Muted by the wallet for lack of balance; a top-up resumes it, unmuting by hand needs balance too.

pausedForNoiseboolean required

Muted by the noise brake: on a workspace running on its welcome credit, at least 20 of its matches were scored and under 30% were relevant. A change of its required or excluded terms, platforms or context resumes it (when the balance covers another day), and so does unmuting; a top-up does not.

pausedForCapboolean required

At its monthly mention cap: not matched until the first of next month (UTC) or until the cap is raised. Not muted: it keeps its place and its daily keyword charge.

platformsstring[] nullable required

Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).

readsWorkspaceFeedsboolean required

true (the default): the keyword also reads every feed of the workspace (GET /v1/feeds), on top of its own feeds. false: its own feeds alone.

contextstring nullable required

A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.

createdAtstring required

ISO 8601 timestamp, UTC.

Changes

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