Menu

Referência da API · Rankings

Etiquetas

seo_rankings · labels · 4 operações

GET/v1/seo/rankings/labels

List keyword labels

seo_rankings.labels.list

LeituraIdempotenteDesde 2026-11-01

Lists the organization's keyword labels (name, color, order) in the order of the app, paginated by cursor. Labels group tracked keywords (by topic, landing page, priority…) and filter seo_rankings.keywords.list; assign them with seo_rankings.keywords.bulk.set_labels. Create them with seo_rankings.labels.create, rename, recolor or move them with seo_rankings.labels.update and delete them with seo_rankings.labels.delete. created_by_name is the name of who created it (null for the ones created in the app, which does not record it).

Escopo
seo_rankings:read
Permissão
Ver o módulo
Tool do MCP
seo_rankings_labels_listNa superfície completa; na compacta, mb_execute_operation com id: "seo_rankings.labels.list".

Custo declarado: até 100 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

limitintegerqueryopcional

How many items this page brings at most (see the maximum and the default in the schema).

Padrão: 50

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

Exemplo

curl "https://api.mb-suite.com/v1/seo/rankings/labels" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/seo/rankings/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/seo/rankings/labels

Create a keyword label

seo_rankings.labels.create

EscritaDesde 2026-11-01

Creates a keyword label at the end of the organization's list, the same labels the Rankings screen manages: name (1 to 60 characters) and an optional hex color such as #3b82f6 (without it, the color of the app's palette for its position). Like the screen, it does not check for another label with the same name: look it up first with seo_rankings.labels.list. Assign it with seo_rankings.keywords.bulk.set_labels or label_ids when adding keywords. Returns label_id and the label. Requires edit access to Rankings.

Escopo
seo_rankings:write
Permissão
Editar no módulo
Tool do MCP
seo_rankings_labels_createNa superfície completa; na compacta, mb_execute_operation com id: "seo_rankings.labels.create".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

namestringcorpoobrigatório

Label name (1 to 60 characters).

colorstringcorpoopcional

Hex color such as #3b82f6; without it, the color of the app's palette for its position.

Resposta

label_idstring
labelobject

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/seo/rankings/labels" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/seo/rankings/labels" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'
PATCH/v1/seo/rankings/labels/{label_id}

Rename, recolor or move a keyword label

seo_rankings.labels.update

EscritaIdempotenteDesde 2026-11-01

Changes a keyword label, sent inside updates: name (1 to 60 characters), a hex color such as #3b82f6 and order (its position in the list, 0 = first; the other labels keep theirs, as when the app saves one label). The keywords that carry it keep it. Setting what it already has changes nothing (changed false, no write). 404 rank_label_not_found when the label is not in this organization. Unknown fields are rejected. Returns the label and changed. Requires edit access to Rankings.

Escopo
seo_rankings:write
Permissão
Editar no módulo
Tool do MCP
seo_rankings_labels_updateNa superfície completa; na compacta, mb_execute_operation com id: "seo_rankings.labels.update".

Custo declarado: até 1 leituras e 1 escritas por chamada (contam na cota diária).

Parâmetros

label_idstringrotaobrigatório

Keyword label id (from seo_rankings.labels.list).

updatesobjectcorpoobrigatório

The fields to change (at least one): name, color, order.

Resposta

labelobject
changedboolean

Erros

Exemplo

curl -X PATCH "https://api.mb-suite.com/v1/seo/rankings/labels/{label_id}" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X PATCH "https://api.mb-suite.com/v1/seo/rankings/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": {}
}'
DELETE/v1/seo/rankings/labels/{label_id}

Delete a keyword label

seo_rankings.labels.delete

IrreversívelDesde 2026-11-01

Deletes a keyword label and takes it off every keyword of the organization that carries it, as the Rankings screen does; the keywords themselves and their history are not touched. The label stays 30 days in the trash: restored (platform.trash.restore), it comes back with its id, name, color and order but not on the keywords, so reassign it with seo_rankings.keywords.bulk.set_labels. Outside the app it needs a dry run, which names the label and counts the keywords that lose it, and its confirm_token. 404 rank_label_not_found when the label is not in this organization. Returns ok and keywords_updated. Requires edit access to Rankings.

Com uma API key, este DELETE roda direto: o registro fica 30 dias na lixeira e a resposta traz o seu trash_item_id. Com um token OAuth, e pelo MCP, pede dry_run → confirm_token.

Escopo
seo_rankings:write e «Permitir exclusões» (seo_rankings:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
seo_rankings_labels_deleteNa superfície completa; na compacta, mb_execute_operation com id: "seo_rankings.labels.delete".

Custo declarado: até 501 leituras e 501 escritas por chamada (contam na cota diária).

Parâmetros

label_idstringrotaobrigatório

Keyword label id (from seo_rankings.labels.list).

Resposta

oktrue
keywords_updatednumber

Keywords that carried the label and lost it.

trash_item_idstring

The trash item this deletion left: the item_id of platform.trash.restore (POST /trash/{item_id}/restore). Missing if nothing went to the trash.

trash_item_idsarray<string>

Only when the deletion left more than one copy: all of them, the first being trash_item_id.

trash_expires_atnumber

When the copy leaves the trash for good (epoch ms): 30 days after the deletion.

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/seo/rankings/labels/{label_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X DELETE "https://api.mb-suite.com/v1/seo/rankings/labels/{label_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"