Search Console URL Inspection
Inspects one URL of a Search Console property: whether Google has indexed it, why not, its last crawl, canonical and rich results.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ search-console. inspect_urlAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/search-console.inspect_url with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/search-console.inspect_url" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"siteUrl":"sc-domain:example.com","url":"https://www.example.com/blog/running-shoes"}'const res = await fetch('https://api.primaryapi.com/v1/run/search-console.inspect_url', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
siteUrl: 'sc-domain:example.com',
url: 'https://www.example.com/blog/running-shoes',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/search-console.inspect_url",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"siteUrl": "sc-domain:example.com",
"url": "https://www.example.com/blog/running-shoes",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "search-console.inspect_url",
"input": {
"siteUrl": "sc-domain:example.com",
"url": "https://www.example.com/blog/running-shoes"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/search-console.inspect_url" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"siteUrl":"sc-domain:example.com","url":"https://www.example.com/blog/running-shoes"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
siteUrlstringrequired- The Search Console property, exactly as search-console.sites lists it: "sc-domain:example.com" for a Domain property, or a URL-prefix property with its trailing slash, e.g. "https://www.example.com/".max 2048 chars
urlstringrequired- Full URL of the page to inspect; it must belong to siteUrl (same domain, or under the URL prefix).max 2048 chars
languageCodestringdefault"en-US"- Language of the issue messages (BCP-47, default "en-US").pattern: ^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$
connectionstring- Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts.max 200 chars
Output
When output.found is true, output.data has these fields.
urlstringsiteUrlstringresultLinkstring | null- Opens this inspection in Search Console
verdictstring | null- PASS, FAIL, NEUTRAL (PARTIAL is no longer used)
coverageStatestring | null- Plain-language index status, e.g. "Submitted and indexed"
indexingStatestring | null- INDEXING_ALLOWED, BLOCKED_BY_META_TAG or BLOCKED_BY_HTTP_HEADER
robotsTxtStatestring | null- ALLOWED or DISALLOWED
pageFetchStatestring | null- SUCCESSFUL, SOFT_404, NOT_FOUND, SERVER_ERROR, REDIRECT_ERROR, …
lastCrawlTimestring | nullcrawledAsstring | null- DESKTOP or MOBILE
googleCanonicalstring | nulluserCanonicalstring | nullsitemapsstring[]- Sitemaps that list this URL
referringUrlsstring[]richResultsobject | null- Structured data Google found (null when none)
richResults.verdictstring | nullrichResults.itemsobject[]richResults.items[].typestring | nullrichResults.items[].namestring | nullrichResults.items[].issuesobject[]richResults.items[].issues[].messagestring | nullrichResults.items[].issues[].severitystring | nullampobject | null- AMP version results (null when the page has no AMP version)
amp.verdictstring | nullamp.ampUrlstring | nullamp.indexingStatestring | nullamp.pageFetchStatestring | nullamp.lastCrawlTimestring | nullamp.issuesobject[]amp.issues[].messagestring | nullamp.issues[].severitystring | null
TypeScript type
/** output.data when output.found is true */
type SearchConsoleInspectUrl = {
url: string;
siteUrl: string;
/** Opens this inspection in Search Console */
resultLink: string | null;
/** PASS, FAIL, NEUTRAL (PARTIAL is no longer used) */
verdict: string | null;
/** Plain-language index status, e.g. "Submitted and indexed" */
coverageState: string | null;
/** INDEXING_ALLOWED, BLOCKED_BY_META_TAG or BLOCKED_BY_HTTP_HEADER */
indexingState: string | null;
/** ALLOWED or DISALLOWED */
robotsTxtState: string | null;
/** SUCCESSFUL, SOFT_404, NOT_FOUND, SERVER_ERROR, REDIRECT_ERROR, … */
pageFetchState: string | null;
lastCrawlTime: string | null;
/** DESKTOP or MOBILE */
crawledAs: string | null;
googleCanonical: string | null;
userCanonical: string | null;
/** Sitemaps that list this URL */
sitemaps: string[];
referringUrls: string[];
/** Structured data Google found (null when none) */
richResults: {
verdict: string | null;
items: {
type: string | null;
name: string | null;
issues: {
message: string | null;
severity: string | null;
}[];
}[];
} | null;
/** AMP version results (null when the page has no AMP version) */
amp: {
verdict: string | null;
ampUrl: string | null;
indexingState: string | null;
pageFetchState: string | null;
lastCrawlTime: string | null;
issues: {
message: string | null;
severity: string | null;
}[];
} | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"url": "https://www.example.com/blog/running-shoes",
"siteUrl": "sc-domain:example.com",
"resultLink": "https://search.google.com/search-console/inspect?resource_id=sc-domain:example.com&id=abc123",
"verdict": "PASS",
"coverageState": "Submitted and indexed",
"indexingState": "INDEXING_ALLOWED",
"robotsTxtState": "ALLOWED",
"pageFetchState": "SUCCESSFUL",
"lastCrawlTime": "2026-11-12T03:15:22Z",
"crawledAs": "MOBILE",
"googleCanonical": "https://www.example.com/blog/running-shoes",
"userCanonical": "https://www.example.com/blog/running-shoes",
"sitemaps": [
"https://www.example.com/sitemap.xml"
],
"referringUrls": [
"https://www.example.com/blog/"
],
"richResults": {
"verdict": "PASS",
"items": [
{
"type": "Breadcrumbs",
"name": "Unnamed item",
"issues": []
}
]
},
"amp": null
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Runs as your connected Google account and needs the Read Search Console capability (search_console_read). It reports Google’s index status for the URL; it does not request indexing. Search Console allows 2,000 inspections per property per day. A property the account cannot see is a miss with reason no_access.
More Google Search Console endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/search-console.inspect_url.