# Search Console URL Inspection (`search-console.inspect_url`)

Inspects one URL of a Search Console property: whether Google has indexed it, why not, its last crawl, canonical and rich results.

Docs: https://primaryapi.com/docs/api-reference/search-console/inspect_url

- Endpoint: `POST https://api.primaryapi.com/v1/run/search-console.inspect_url`
- Category: Search & SEO · Platform: `search-console` · Kind: lookup · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=search-console.inspect_url`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `siteUrl` | string | yes |  | max 2048 chars | 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/". |
| `url` | string | yes |  | max 2048 chars | Full URL of the page to inspect; it must belong to siteUrl (same domain, or under the URL prefix). |
| `languageCode` | string | no | "en-US" | pattern: ^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$ | Language of the issue messages (BCP-47, default "en-US"). |
| `connection` | string | no |  | max 200 chars | 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. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `url` | string |  |
| `siteUrl` | string |  |
| `resultLink` | string \| null | Opens this inspection in Search Console |
| `verdict` | string \| null | PASS, FAIL, NEUTRAL (PARTIAL is no longer used) |
| `coverageState` | string \| null | Plain-language index status, e.g. "Submitted and indexed" |
| `indexingState` | string \| null | INDEXING_ALLOWED, BLOCKED_BY_META_TAG or BLOCKED_BY_HTTP_HEADER |
| `robotsTxtState` | string \| null | ALLOWED or DISALLOWED |
| `pageFetchState` | string \| null | SUCCESSFUL, SOFT_404, NOT_FOUND, SERVER_ERROR, REDIRECT_ERROR, … |
| `lastCrawlTime` | string \| null |  |
| `crawledAs` | string \| null | DESKTOP or MOBILE |
| `googleCanonical` | string \| null |  |
| `userCanonical` | string \| null |  |
| `sitemaps` | string[] | Sitemaps that list this URL |
| `referringUrls` | string[] |  |
| `richResults` | object \| null | Structured data Google found (null when none) |
| `richResults.verdict` | string \| null |  |
| `richResults.items` | object[] |  |
| `richResults.items[].type` | string \| null |  |
| `richResults.items[].name` | string \| null |  |
| `richResults.items[].issues` | object[] |  |
| `richResults.items[].issues[].message` | string \| null |  |
| `richResults.items[].issues[].severity` | string \| null |  |
| `amp` | object \| null | AMP version results (null when the page has no AMP version) |
| `amp.verdict` | string \| null |  |
| `amp.ampUrl` | string \| null |  |
| `amp.indexingState` | string \| null |  |
| `amp.pageFetchState` | string \| null |  |
| `amp.lastCrawlTime` | string \| null |  |
| `amp.issues` | object[] |  |
| `amp.issues[].message` | string \| null |  |
| `amp.issues[].severity` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
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"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "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

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=search-console.inspect_url`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## 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.

