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

فهرست بررسی ها

GET/sites/{siteId}/audits
Scope
sites:read
ابزار MCP
audit_status

List audits, the running one and budgets.

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

پارامترها

ناممحلتوضیح
siteIdاجباریpathstringWebsite id, from GET /sites.
limitqueryintegerdefault 5, min 1, max 25Audits to return, 1 to 25.

پاسخ

200 · application/json

فیلدتوضیح
auditslist of values · required; Full audits, newest first
audits[].idstring
audits[].kindstring
audits[].statusstring
audits[].stagestring
audits[].pagesCrawlednumber
audits[].pagesDiscoverednumber
audits[].pageBudgetnumber
audits[].timeLimitMinutesnumber
audits[].cappedByPlantrue or false
audits[].coverageobject
audits[].coverage.sitemapUrlsnumber
audits[].coverage.sitemapCrawlednumber
audits[].coverage.percentnumber
audits[].partialReason
audits[].issuesFoundnumber
audits[].startedBystring
audits[].queuedAtstring
audits[].startedAtstring
audits[].finishedAtstring
audits[].error
audits[].linkstring
activerequired; The crawl queued or running now (an audit or a recheck); null when none
nextScheduledAtstring or null · required; The next weekly audit (Sundays 02:00 UTC); null for a paused website
pageBudgetobject · required
pageBudget.defaultinteger · required; Pages an audit gets without pageBudget
pageBudget.planLimitinteger · required; The plan's pages per audit
pageBudget.websiteSettinginteger · required; The website's own audit budget (Settings → Audit)
apiStartsobject · required
apiStarts.perDayinteger · required; Audits per website per 24 hours through the API and MCP
apiStarts.usedTodayinteger · required; Used in the last 24 hours
apiStarts.leftinteger · required; Left

خطاها

کدمعنی
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.

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

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

نمونه پاسخ

{
  "audits": [
    {
      "id": "d4f6a8c0-2e4a-4c6e-8a0c-4e6a8c0e2a4b",
      "kind": "audit",
      "status": "done",
      "stage": "done",
      "pagesCrawled": 412,
      "pagesDiscovered": 418,
      "pageBudget": 500,
      "timeLimitMinutes": 30,
      "cappedByPlan": false,
      "coverage": {
        "sitemapUrls": 398,
        "sitemapCrawled": 391,
        "percent": 98
      },
      "partialReason": null,
      "issuesFound": 23,
      "startedBy": "schedule",
      "queuedAt": "2026-10-04T02:00:01.000Z",
      "startedAt": "2026-10-04T02:00:04.000Z",
      "finishedAt": "2026-10-04T02:41:12.000Z",
      "error": null,
      "link": "https://app.monoranks.com/sites/3f6c2a1e-8b4d-4c7a-9e21-5d0b7a6f4c13/audit"
    }
  ],
  "active": null,
  "nextScheduledAt": "2026-10-11T02:00:00.000Z",
  "pageBudget": {
    "default": 500,
    "planLimit": 500,
    "websiteSetting": 500
  },
  "apiStarts": {
    "perDay": 3,
    "usedToday": 1,
    "left": 2
  }
}

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