مستندات توسعه دهندگان

Compare a page title with the top 5 Google results

POST/sites/{siteId}/pages/{pageId}/title-compare
Scope
actions:apply
ابزار MCP
run_title_compare

Compare a page title with the top 5 Google results Runs the comparison and stores it, like "Compare title with top results" in the app. Reuses Google results for the keyword stored in the last 7 days (rerun: last day only, and new suggestions); otherwise uses one keyword lookup from the monthly plan, inside the spending limits. Nothing is written to the website.

توضیح ها از سند OpenAPI می آیند و انگلیسی اند.

پارامترها

ناممحلتوضیح
siteIdاجباریpathstringWebsite id, from GET /sites.
pageIdاجباریpathstringPage id, from GET /pages or GET /pages/findings.

بدنه درخواست

فیلدتوضیح
keywordstring · at most 80 characters; The search to compare for; default: the page's main keyword (the first of keywordChoices)
reruntrue or false · Ask for fresh results (older than a day) and new suggestions
languageen | de | es | fa · Language of the notes and reasons; default en
{
  "keyword": "what is aeo",
  "language": "en"
}

پاسخ

200 · application/json

فیلدتوضیح
pageobject · required
page.idstring · required
page.urladdress (URL) · required
comparisonobject · required
comparison.keywordstring
comparison.locationCodenumber
comparison.languageCodestring
comparison.comparedAtstring
comparison.resultsobject
comparison.results.datestring
comparison.results.sourcestring
comparison.results.checkUrlstring
comparison.results.toplist of objects
comparison.results.top[].positionnumber
comparison.results.top[].domainstring
comparison.results.top[].urlstring
comparison.results.top[].titlestring
comparison.results.top[].lengthnumber
comparison.oursobject
comparison.ours.titlestring
comparison.ours.lengthnumber
comparison.ours.position
comparison.ours.positionSource
comparison.findingslist of objects
comparison.findings[].keystring
comparison.findings[].valuesobject
comparison.findings[].values.oursnumber
comparison.findings[].values.minnumber
comparison.findings[].values.maxnumber
comparison.noteslist of strings
comparison.notesLanguagestring
comparison.suggestionslist of objects
comparison.suggestions[].titlestring
comparison.suggestions[].lengthnumber
comparison.suggestions[].whystring
comparison.resultsCostUsdnumber
costobject · required
cost.usdnumber · required; What this run paid for results
cost.lookupsinteger · required; Keyword lookups used: 1, or 0 when stored results were reused
cost.reusedtrue or false · required; Stored results were reused
aiNotestring or null · required; Why notes and suggestions are missing (the daily AI limit, the AI could not answer); the measured findings are still there
linkaddress (URL) · required

خطاها

کدمعنی
400Bad request. Codes: missing_argument, bad_keyword, no_keyword.
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.
422The request cannot be carried out. Codes: unsupported_location, no_results.
429A limit is reached. rate_limited: too many requests this hour for this key. Codes: rate_limited, lookups, workspace_cap, global_cap.
502An outside service did not answer. Codes: failed.
503Switched off for now. Codes: no_provider.

نمونه درخواست

curl -X POST \
  -H "Authorization: Bearer mr_ws_…" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"what is aeo","language":"en"}' \
  "https://app.monoranks.com/api/v1/sites/SITE_ID/pages/PAGE_ID/title-compare"

نمونه پاسخ

{
  "page": {
    "id": "c7a9e1b3-5d7f-4b9c-8e1a-3c5e7a9b1d2f",
    "url": "https://acmebikes.com/learn/what-is-aeo/"
  },
  "comparison": {
    "keyword": "what is aeo",
    "locationCode": 2840,
    "languageCode": "en",
    "comparedAt": "2026-10-09T08:12:51.000Z",
    "results": {
      "date": "2026-10-09",
      "source": "live",
      "checkUrl": "https://www.google.com/search?q=what%20is%20aeo&num=10&hl=en&gl=US",
      "top": [
        {
          "position": 1,
          "domain": "enterprise-search.example",
          "url": "https://enterprise-search.example/aeo-guide",
          "title": "What is Answer Engine Optimization? Enterprise Guide to AEO",
          "length": 59
        },
        {
          "position": 2,
          "domain": "searchfuture.example",
          "url": "https://searchfuture.example/blog/what-is-aeo",
          "title": "What is answer engine optimization (AEO)? Understanding AEO for the future of search",
          "length": 84
        },
        {
          "position": 3,
          "domain": "aeoguide.example",
          "url": "https://aeoguide.example/",
          "title": "Answer Engine Optimization: Complete AEO Guide [2026]",
          "length": 53
        },
        {
          "position": 4,
          "domain": "marketingdocs.example",
          "url": "https://marketingdocs.example/aeo",
          "title": "What Is Answer Engine Optimization (AEO)? A Complete Guide",
          "length": 58
        },
        {
          "position": 5,
          "domain": "aisearchtools.example",
          "url": "https://aisearchtools.example/learn/aeo",
          "title": "Show Up in AI Search with Answer Engine Optimization (AEO)",
          "length": 58
        }
      ]
    },
    "ours": {
      "title": "What is AEO? A simple explanation",
      "length": 33,
      "position": null,
      "positionSource": null
    },
    "findings": [
      {
        "key": "length",
        "values": {
          "ours": 33,
          "min": 53,
          "max": 84
        }
      },
      {
        "key": "phrase",
        "values": {
          "phrase": "answer engine optimization",
          "count": 5,
          "n": 5
        }
      },
      {
        "key": "phrase",
        "values": {
          "phrase": "guide",
          "count": 3,
          "n": 5
        }
      },
      {
        "key": "farDown",
        "values": {
          "position": 0
        }
      }
    ],
    "notes": [
      "Every top result spells out \"Answer Engine Optimization\"; your title only says \"AEO\", so people who search the full name do not see their words."
    ],
    "notesLanguage": "en",
    "suggestions": [
      {
        "title": "What is AEO? Answer Engine Optimization Explained",
        "length": 49,
        "why": "Keeps your plain question and spells out the full name people search for."
      },
      {
        "title": "What is AEO (Answer Engine Optimization)? A Simple Guide",
        "length": 56,
        "why": "Adds the full name and the word guide that most top results use, in your simple voice."
      }
    ],
    "resultsCostUsd": 0.002
  },
  "cost": {
    "usd": 0.002,
    "lookups": 1,
    "reused": false
  },
  "aiNote": null,
  "link": "https://app.monoranks.com/sites/3f6c2a1e-8b4d-4c7a-9e21-5d0b7a6f4c13/pages/c7a9e1b3-5d7f-4b9c-8e1a-3c5e7a9b1d2f#title-compare"
}

سرور MCP همین کار را با ابزار run_title_compare انجام می دهد.