Site Access
Get site access
Read whether AI crawlers and search engines can fetch a brand's site: each crawler's verdict, the findings and history.
/v1/brands/{brand_id}/site-accessThe brand's latest Site Access check and its completed checks, newest first.
Authorization
AuthorizationstringheaderrequiredYour API key as Bearer ranqo_sk_…. The account owner creates keys in Settings, under API keys. See Authentication.
Path parameters
brand_idstringrequiredThe brand id, from GET /v1/brands.
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/site-access" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
The response body, as JSON.
brand_idstringcheckobject or nullWhether AI crawlers and search engines can fetch the site: each one fetches the homepage beside a browser. Null when the brand has never run a check.
Show 13 fields insideHide the fields inside
statusstringThe latest check's state. A check that stopped reporting reads
failed. One ofpending,running,completed,failed.originstringThe site the latest check was pointed at: after redirects once it completes, the brand's own domain while it runs or if it failed.
checked_atstring or nullRFC 3339 timestamp in UTC. When the check the findings below come from completed. While a new check runs, or after one fails, they stay that earlier check's. Null before any check completes.
verdictstring or nullunknowncomes first: no browser could load the homepage either, or robots.txt disallows RanqoBot, so the crawlers' results cannot be read, whatever else was found. Otherwiseblocked: a crawler that feeds live AI answers is refused at the edge, or robots.txt turns away a live-answer or search crawler.warn: something worth a look, such as a search or training crawler refused at the edge, or no sitemap.clear: no blocker and no warning; notices may remain. Null before any check completes. One ofclear,warn,blocked,unknown.reachableboolean or nullWhether a browser could load the homepage, the control every crawler is read against; null when not measured.
countsobject or nullFindings by severity, and
passes, the crawlers with apassverdict: those that received the page, and robots.txt-only tokens the file allows. Null before any check completes.Show 4 fields insideHide the fields inside
blockersintegerwarningsintegernoticesintegerpassesinteger
findingsarray of objectsShow 4 fields insideHide the fields inside
idstringseveritystringOne of
blocker,warn,notice.titlestringdetailstring
crawlersarray of objectsEach crawler that fetched the homepage, read against the browser control; tokens that exist only in robots.txt, such as Google-Extended, are never requested and carry only their robots.txt verdict.
Show 9 fields insideHide the fields inside
keystringThe crawler's robots.txt token.
labelstringvendorstringrolestringWhat the crawler feeds. One of
live_answer,training,search.verdictstringOne of
pass,blocked,rate_limited,thin,robots_disallowed,unknown.http_statusinteger or nullfetch_errorstring or nullSet when the request got no HTTP answer. One of
timeout,error.latency_msnumber or nullwordsinteger or nullVisible words the crawler received.
robots_txtobject or nullShow 5 fields insideHide the fields inside
statusstring or nullok,missing,unreadable,cdn-blockedorranqo-disallowed.http_statusinteger or nulldisallowed_aiarray of stringsAI crawlers the file turns away from the homepage.
disallowed_searcharray of stringsSearch crawlers the file turns away from the homepage.
declares_sitemapbooleanWhether the file has a
Sitemap:line; false also when it could not be read (statusisunreadableorcdn-blocked).
llms_txtobject or nullShow 6 fields insideHide the fields inside
urlstringpresentbooleanA real llms.txt: a 200 serving HTML does not count.
http_statusinteger or nullsectionsintegerlinksintegerchecksarray of objectsShow 3 fields insideHide the fields inside
idstringokbooleantitlestring
sitemapobject or nullShow 6 fields insideHide the fields inside
urlstring or nullreachablebooleanhttp_statusinteger or nullurl_countintegerdeclared_in_robotsbooleanWhether robots.txt lists a sitemap; false also when robots.txt could not be read (
robots_txt.statusisunreadableorcdn-blocked).newest_lastmodstring or null
fetch_countinteger or nullRequests the check sent to the site.
errorstring or nullWhy the latest check failed; null otherwise.
historyarray of objectsCompleted checks, newest first, the latest completed one included, at most 26.
Show 6 fields insideHide the fields inside
checked_atstringRFC 3339 timestamp in UTC.
verdictstringunknowncomes first: no browser could load the homepage either, or robots.txt disallows RanqoBot, so the crawlers' results cannot be read, whatever else was found. Otherwiseblocked: a crawler that feeds live AI answers is refused at the edge, or robots.txt turns away a live-answer or search crawler.warn: something worth a look, such as a search or training crawler refused at the edge, or no sitemap.clear: no blocker and no warning; notices may remain. One ofclear,warn,blocked,unknown.blockersintegerwarningsintegernoticesintegernotestringWhat changed since the check before; "First check" on the first.
Response headers
X-Request-IdThe request id; quote it to support.
RateLimitRequests left in this window and seconds until it resets.
RateLimit-PolicyThe key's limit per window.
Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.