Skip to content

Keyword

A Keyword is a search phrase or AI prompt that Pages target, with its rank and citations observed over time.

Properties

PropertyTypeRequiredDescription
phrasestringrequiredThe words searched or asked.
formstringOne of search or question.

Object

JSON
{
  "$id": "https://api.sb/routewise.dev/keywords/keyword_1",
  "$type": "Keyword",
  "phrase": "Example phrase",
  "form": "search"
}

Relationships

  • A Keyword is targeted by many Pages: a Page is written to rank for, or be cited on, its Keywords. targetedBy, inverse targets.

Verbs

  1. createCreates a Keyword.
    POST /{namespace}/keywordsdoKeyword.created
  2. getReturns one Keyword by id.
    GET /{namespace}/keywords/{id}readNo Event
  3. listReturns Keywords, newest first, one page at a time.
    GET /{namespace}/keywordsreadNo Event
  4. updateChanges the given properties of a Keyword.
    PATCH /{namespace}/keywords/{id}doKeyword.updated
  5. deleteDeletes a Keyword; its history is kept.
    DELETE /{namespace}/keywords/{id}doKeyword.deleted
  6. measureMeasure records a Keyword’s monthly search volume, difficulty, cost per click and trend in one locale.
    POST /{namespace}/keywords/{keyword}/measuredoKeyword.measured

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Keyword.createYesYesYesNo
Keyword.getYesYesYesYes
Keyword.listYesYesYesYes
Keyword.updateYesYesYesNo
Keyword.deleteYesYesYesNo
Keyword.measureYesYesYesNo

Call it

Text
Measure the latest keyword.

Example

The Keyword "home inspector near me" is targeted by the city Pages of an inspector directory. Its largest city Page ranks third and is cited in one AI answer this week.