Entwicklerdokumentation

Ein Problem abrufen

GET/sites/{siteId}/issues/{issueId}
Berechtigung
issues:read
MCP-Tool
issue_detail

Get an issue with pages, evidence and suggestions For a writable field other than alt, suggestions gives the rule-based value per affected page, 100 per call: page with suggestions_offset. A recheck reads every listed page fresh, so affected, evidence and suggestions show what the pages say now.

Die Beschreibungen kommen aus dem OpenAPI-Dokument und sind auf Englisch.

Parameter

NameOrtDetails
siteIdPflichtPfadstringWebsite id, from GET /sites.
issueIdPflichtPfadstringIssue id, from GET /sites/{siteId}/issues or /actions.
suggestions_offsetQueryintegerdefault 0, min 0, max 1000000Suggestions to skip (suggestionsNextOffset of the previous page).
suggestions_limitQueryintegerdefault 100, min 1, max 100Most suggestions to return, 1 to 100.
suggestionsOffsetQueryintegerdefault 0, min 0, max 1000000Same as suggestions_offset; the snake_case name wins when both are sent.
suggestionsLimitQueryintegerdefault 100, min 1, max 100Same as suggestions_limit.

Antwort

200 · application/json

FeldDetails
idstring · required; Issue id
ruleIdstring · required; Rule that found it, for example SEO-ONP-011
titlestring · required; Issue title
categorystring · required; Rule category, for example Technical, On-page, Internal linking, Performance, Structured data, AEO readiness or Google Ads (the Ads waste checks, ADS-* rules: about the Ads account, so they list no pages and carry their rows in example.rows)
severitycritical | serious | warning | low · required; How much it hurts
confidencehigh | medium | low · required; How sure the rule is
statusopen | in_progress | recheck_queued | resolved | ignored | reopened · required; Where the issue stands
affectedPagesinteger · required; Pages the issue lists
templatestring · required; The group of pages: Template: /blog/*, Site-level, or a count of URLs
summarystring · required; One line on what was found
firstSeenstring · required; First found
lastSeenstring · required; Last found
lastRecheckrequired; What the last recheck found; null before any recheck
linkstring · required; The issue in the app
whystring or null · required; Why it matters
affectedlist of object · required; Affected pages (first 50)
affected[].urlstring · required; Page address
affected[].evidencerequired; What the rule saw on the page
affectedTotalinteger · required; All affected pages
explanationobject or null · required; The AI explanation when drafted; null otherwise
explanation.summarystring · required; What is wrong
explanation.summaryRefslist of string · required; Evidence the summary is based on
explanation.whystring · required; Why it matters
explanation.stepslist of object · required
explanation.steps[].textstring · required; Fix step
explanation.steps[].refslist of string · required; Evidence for the step
explanation.doNotTouchlist of string · required; What to leave alone
explanation.verifystring · required; How to check the fix
explanation.draftedstring · required; Always "AI-drafted from evidence"
writableFieldseo_title | seo_description | canonical | noindex | alt | redirect | · required; The field MonoRanks can write for this issue; null when none
suggestionslist of object · Writable fields other than alt: the suggested value per affected page, the same as the app shows before Apply
suggestions[].urlstring · required; Page address
suggestions[].pageIdstring · required; Page id
suggestions[].currentstring · required; What the page shows now
suggestions[].suggestedstring or null · required; The rule-based value MonoRanks suggests; null when there is none
suggestions[].adviceobject or null · Meta descriptions only: advice for pages that may not need one
suggestions[].advice.pageKindlegal | archive | empty_archive | empty_page | account · required; legal page, archive, empty archive, near-empty page, or a logged-in, cart or checkout page
suggestions[].advice.legalKindprivacy | cookie | terms | imprint | legal · Kind of legal page
suggestions[].advice.recommendedleave_or_noindex | add_posts_or_noindex | add_content_or_noindex | noindex · required; What to do besides or instead of a description
suggestions[].advice.messagestring · required; The advice in words
suggestions[].writabletrue or false · required; Whether apply can write this page
suggestions[].notWritableReasonstring · Why apply cannot write this page
suggestionsNotestring or null · Titles only: the site changes the letter case of every title (for example Rank Math's Capitalize Titles)
suggestionsTotalinteger · Suggestions over all pages
suggestionsOffsetinteger · Suggestions skipped
suggestionsLimitinteger · Most suggestions in this answer
suggestionsNextOffsetinteger or null · Send as suggestions_offset for the next page; null after the last
suggestionsTruncatedtrue or false · More suggestions after this page
titleTemplateobject or null · Too-long titles (SEO-ONP-005) only: one template ending that makes most titles too long
titleTemplate.suffixstring · required; The shared ending
titleTemplate.countinteger · required; Titles carrying it
titleTemplate.notestring · required; Where to shorten it once
lastChangeobject or null · required; The last approved change batch; null when none
lastChange.batchIdstring · required; Batch id
lastChange.approvedBystring · required; Who approved it
lastChange.approvedAtstring · required; When it was approved
lastChange.changeslist of object · required; First 50 changes
lastChange.changes[].urlstring · required; Page address
lastChange.changes[].fieldstring · required; Field written, for example seo_description
lastChange.changes[].valuestring · required; The approved value
lastChange.changes[].statusapproved | applying | applied | not_live | failed | refused | stale | reverting | reverted | revert_failed · required; applied: written and seen on the live page; not_live: written, but the page still shows another value; refused: the plugin cannot write this field here; stale: the field changed in WordPress after the review, so it is back in review
lastChange.changes[].appliedAtstring or null · required; When it was written
lastChange.changes[].livetrue or false or null · required; Whether the recheck saw the value on the live page
lastChange.changes[].liveValuestring or null · required; What the live page showed
lastChange.changes[].notLiveReasonstring or null · required; not_live only: why, including whether the page cache was cleared
lastChange.changes[].liveNotestring or null · required; applied only: for example the page shows the value in another letter case
lastChange.changes[].errorstring or null · required; Why it failed or was refused

Hinweise

Für ein Problem, das MonoRanks beheben kann (SEO-Titel, Meta-Beschreibung, Canonical oder Weiterleitung), gibt GET /sites/{siteId}/issues/{issueId} auch suggestions zurück: für jede betroffene Seite den aktuellen Wert und den Wert, den MonoRanks vorschlägt. Es sind dieselben Werte, die die App zeigt, bevor Sie auf Apply drücken.

"suggestions": [
  { "url": "https://example.com/pricing/", "pageId": "…", "current": "Pricing", "suggested": "Pricing | Example", "writable": true }
],
"suggestionsTotal": 240,
"suggestionsOffset": 0,
"suggestionsLimit": 100,
"suggestionsNextOffset": 100,
"suggestionsTruncated": true
Was Details
Blättern Jeder Aufruf liefert bis zu 100. Für die nächsten rufen Sie erneut auf, mit ?suggestions_offset= gleich suggestionsNextOffset; nach der letzten Seite ist es null. suggestions_limit (1 bis 100) legt die Seitengröße fest. Die Schreibweisen suggestionsOffset und suggestionsLimit funktionieren auch.
suggested ist null, wenn MonoRanks für diese Seite keinen guten neuen Wert hat. Ein zu langer Titel wird nach festen Regeln gekürzt, die das Thema der Seite behalten und nie einen Ausdruck mittendrin abschneiden; wenn kein kürzerer Titel passt, ist suggested null und Sie können in der App einen entwerfen.
suggestionsNote (nur Titel) ist gesetzt, wenn die Website die Groß- und Kleinschreibung von Titeln auf der Seite ändert, zum Beispiel mit der Einstellung Capitalize Titles von Rank Math.
writable ist false, mit notWritableReason, wenn apply diese Seite nicht schreiben kann, zum Beispiel ein Kategoriearchiv, das kein WordPress-Beitrag und keine Seite ist. Senden Sie diese nicht an apply.
advice (nur Meta-Beschreibungen) sagt, wann eine Seite vielleicht keine Beschreibung braucht: eine Rechtsseite oder ein Archiv (leer lassen oder noindex setzen), ein leeres Archiv (Beiträge hinzufügen oder noindex setzen) oder eine Login-, Konto-, Warenkorb- oder Kassenseite (noindex setzen; es wird keine Beschreibung vorgeschlagen).
titleTemplate (zu lange Titel) ist gesetzt, wenn eine gemeinsame Endung aus der Titelvorlage des SEO-Plugins die meisten Titel zu lang macht; dann behebt eine Änderung an der Vorlage alle.
lastRecheck sagt, was die letzte erneute Prüfung gefunden hat. Eine Prüfung liest jede gelistete Seite frisch neu, sodass bereits behobene Seiten aus der Liste fallen. Eine Seite, die nicht geantwortet hat, bleibt gelistet und wird in lastRecheck.notRechecked gezählt.
lastChange ist der letzte genehmigte Stapel, mit dem Status jeder Änderung. not_live heißt: geschrieben, aber die Seite zeigt noch einen anderen Wert; notLiveReason sagt warum, auch ob der Seiten-Cache der Website nach dem Schreiben geleert wurde. Eine erneute Prüfung schaut sich solche Änderungen noch einmal an. Titel und Beschreibungen gelten als live, wenn sich nur Groß- und Kleinschreibung, Leerzeichen, Anführungszeichen oder Bindestriche unterscheiden; liveNote sagt dann, was sie geändert hat.

Senden Sie die Werte, die Sie genehmigen, an POST /sites/{siteId}/actions/{issueId}/apply als { "changes": [ { "url": "…", "value": "…" } ] } (höchstens 500). Über die API schreibt apply SEO-Titel, Meta-Beschreibungen, Canonicals und noindex; Alt-Texte von Bildern und Weiterleitungen wenden Sie in der App an.

Persönliche E-Mail-Adressen im Seitentext, den MonoRanks speichert, werden verborgen, zum Beispiel j•••@gmail.com.

Fehler

StatusBedeutung
400Bad request. Codes: bad_paging.
401Missing, unknown or revoked key. Codes: missing_key, invalid_key.
403The key lacks the scope, covers another website, or its owner lost access. Codes: missing_scope, other_site, owner_left, no_owner, forbidden.
404Not found. Codes: not_found.
429Too many requests this hour for this key. Codes: rate_limited.

Beispielanfrage

curl \
  -H "Authorization: Bearer mr_ws_…" \
  "https://app.monoranks.com/api/v1/sites/SITE_ID/issues/ISSUE_ID"

Beispielantwort

{
  "id": "b2e4c6a8-1d3f-4a5b-9c7d-0e2f4a6b8c1d",
  "ruleId": "SEO-ONP-011",
  "title": "Meta description missing on 3 pages (/products/*)",
  "category": "On-page",
  "severity": "warning",
  "confidence": "high",
  "status": "open",
  "affectedPages": 3,
  "template": "Template: /products/*",
  "summary": "3 pages have no meta description. Google shows a snippet cut from the page instead.",
  "firstSeen": "2026-09-20T02:40:03.000Z",
  "lastSeen": "2026-10-04T02:41:12.000Z",
  "lastRecheck": {
    "at": "2026-10-02T09:12:44.000Z",
    "present": 3,
    "checked": 3,
    "crawlId": "e5a7c9e1-3f5b-4d7f-9b1d-5f7b9d1f3b5c",
    "passed": false
  },
  "link": "https://app.monoranks.com/sites/3f6c2a1e-8b4d-4c7a-9e21-5d0b7a6f4c13/issues/b2e4c6a8-1d3f-4a5b-9c7d-0e2f4a6b8c1d",
  "why": "A written description raises click-through from results; it is the one line of ad copy you control.",
  "affected": [
    {
      "url": "https://acmebikes.com/products/trail-pro-29",
      "evidence": {
        "title": "Trail Pro 29 Mountain Bike | Acme Bikes"
      }
    },
    {
      "url": "https://acmebikes.com/products/city-glide-7",
      "evidence": {
        "title": "City Glide 7 | Acme Bikes"
      }
    }
  ],
  "affectedTotal": 3,
  "explanation": null,
  "writableField": "seo_description",
  "suggestions": [
    {
      "url": "https://acmebikes.com/products/trail-pro-29",
      "pageId": "c7a9e1b3-5d7f-4b9c-8e1a-3c5e7a9b1d2f",
      "current": "",
      "suggested": "Trail Pro 29: a light aluminium trail bike with 140 mm travel and a 12-speed drivetrain. Free delivery and 30-day returns.",
      "advice": null,
      "writable": true
    }
  ],
  "suggestionsNote": null,
  "suggestionsTotal": 3,
  "suggestionsOffset": 0,
  "suggestionsLimit": 1,
  "suggestionsNextOffset": 1,
  "suggestionsTruncated": true,
  "lastChange": {
    "batchId": "f6b8d0f2-4a6c-4e8a-ac2e-6a8cae2a4c6d",
    "approvedBy": "sam@acmebikes.com",
    "approvedAt": "2026-10-01T14:03:00.000Z",
    "changes": [
      {
        "url": "https://acmebikes.com/products/city-glide-7",
        "field": "seo_description",
        "value": "City Glide 7: a comfortable seven-speed city bike with mudguards and a rack.",
        "status": "applied",
        "appliedAt": "2026-10-01T14:03:41.000Z",
        "live": true,
        "liveValue": "City Glide 7: a comfortable seven-speed city bike with mudguards and a rack.",
        "notLiveReason": null,
        "liveNote": null,
        "error": null
      }
    ]
  }
}

Der MCP-Server macht dasselbe mit dem Tool issue_detail.