> ## Documentation Index
> Fetch the complete documentation index at: https://rankspot.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check whether a page is indexed

> Inspects a single URL with the Google Search Console URL Inspection API and reports its index status.

**Requires:** Google Search Console connected from the RankSpot dashboard (Integrations → Google Search Console). Works with the existing connection — no reconnect needed.

**Reading the result:** the page is indexed when `indexStatusResult.verdict` is `PASS`. When it is not, check `indexStatusResult.coverageState` (e.g. "Crawled - currently not indexed", "Discovered - currently not indexed", "URL is unknown to Google") for the reason.

**Quota:** The URL Inspection API is limited by Google to ~2,000 queries/day and 600 queries/minute per property.



## OpenAPI

````yaml https://api.rankspot.ai/docs-json post /v1/gsc/inspect
openapi: 3.0.0
info:
  title: RankSpot Public API
  description: >-
    The RankSpot Public API gives you programmatic access to your workspace data
    — keywords, backlinks, competitors, content topics, articles, and more.


    ## Authentication


    All endpoints require a Bearer API key in the `Authorization` header:


    ```

    Authorization: Bearer <your-api-key>

    ```


    Generate API keys from **Settings → API Keys** in the RankSpot dashboard.
    Each key is scoped to a single workspace.


    ## Pagination


    List endpoints return a consistent envelope:


    ```json

    {
      "data": {
        "total": 120,
        "offset": 0,
        "limit": 20,
        "count": 20,
        "items": [...]
      }
    }

    ```


    Use `offset` and `limit` query parameters to paginate. Default limit is
    **20**, maximum is **100**.


    ## Status codes


    | Code | Meaning |

    |------|---------|

    | 200  | Success |

    | 201  | Created |

    | 204  | No content (delete / unarchive) |

    | 400  | Validation error or business rule violation |

    | 401  | Missing or invalid API key |

    | 404  | Resource not found or belongs to another workspace |
  version: '1.0'
  contact: {}
servers:
  - url: https://api.rankspot.ai
    description: Production
security: []
tags:
  - name: Articles
    description: >-
      AI-generated blog articles. Articles are created automatically when a
      topic is sent to generation — they cannot be created directly via the API.
  - name: Backlinks
    description: >-
      Backlinks discovered for your domain and your competitors' domains.
      Backlinks are auto-synced on a background interval and cannot be created
      via the API.
  - name: Categories
    description: Categories for organising topics and articles within your workspace.
  - name: Competitors
    description: >-
      Competitor domains tracked in your workspace. Once added, keywords and
      backlinks for each competitor are fetched asynchronously on a background
      sync interval.
  - name: Forum Opportunities
    description: >-
      Forum threads and community posts surfaced as potential link-building or
      engagement opportunities.
  - name: Keywords
    description: >-
      SEO keywords tracked in your workspace, enriched with search volume,
      competition, and AI-generated relevance scores.
  - name: People Also Ask
    description: >-
      "People also ask" questions discovered from search results for your
      tracked keywords.
  - name: Topics
    description: >-
      Content topic ideas that can be turned into articles. Create topics
      manually or let RankSpot generate them from your keyword clusters.
  - name: Search Console
    description: >-
      Google Search Console performance data — clicks, impressions, CTR, and
      average position for your connected property. Requires GSC to be connected
      from the RankSpot dashboard.
paths:
  /v1/gsc/inspect:
    post:
      tags:
        - Search Console
      summary: Check whether a page is indexed
      description: >-
        Inspects a single URL with the Google Search Console URL Inspection API
        and reports its index status.


        **Requires:** Google Search Console connected from the RankSpot
        dashboard (Integrations → Google Search Console). Works with the
        existing connection — no reconnect needed.


        **Reading the result:** the page is indexed when
        `indexStatusResult.verdict` is `PASS`. When it is not, check
        `indexStatusResult.coverageState` (e.g. "Crawled - currently not
        indexed", "Discovered - currently not indexed", "URL is unknown to
        Google") for the reason.


        **Quota:** The URL Inspection API is limited by Google to ~2,000
        queries/day and 600 queries/minute per property.
      operationId: GscController_inspectUrl
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GscInspectUrlDto'
      responses:
        '200':
          description: >-
            The raw `inspectionResult` from the URL Inspection API. The page is
            indexed when `indexStatusResult.verdict` is `PASS`; otherwise read
            `indexStatusResult.coverageState` for the reason.
          content:
            application/json:
              schema:
                example:
                  inspectionResultLink: >-
                    https://search.google.com/search-console/inspect?resource_id=sc-domain:example.com&id=...
                  indexStatusResult:
                    verdict: PASS
                    coverageState: Submitted and indexed
                    robotsTxtState: ALLOWED
                    indexingState: INDEXING_ALLOWED
                    lastCrawlTime: '2026-06-21T15:58:20Z'
                    pageFetchState: SUCCESSFUL
                    googleCanonical: https://www.example.com/blog
                    userCanonical: https://www.example.com/blog
                    referringUrls:
                      - https://www.example.com/blog/
                    crawledAs: MOBILE
                  mobileUsabilityResult:
                    verdict: VERDICT_UNSPECIFIED
      security:
        - bearer: []
components:
  schemas:
    GscInspectUrlDto:
      type: object
      properties:
        url:
          type: string
          example: https://example.com/blog/my-post
          description: >-
            The fully-qualified URL to inspect. Must belong to the connected
            Search Console property.
        languageCode:
          type: string
          example: en-US
          description: >-
            BCP-47 language code for the inspection result messages. Defaults to
            en-US.
      required:
        - url
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````