---
title: "query_internal_link_snapshot"
method: GET
path: "/v1/internal-links/snapshots/{snapshotId}/query"
---

# query_internal_link_snapshot

`GET /v1/internal-links/snapshots/{snapshotId}/query`

## Request

- Base URL: `https://app.agentlinkops.com`
- URL: `https://app.agentlinkops.com/v1/internal-links/snapshots/{snapshotId}/query`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

The path sets snapshotId. Supply projectId and optional view, numeric limit, opaque cursor, pageUrl, contextualOnly and baselineSnapshotId as query parameters. contextualOnly accepts the literal strings true or false. Returns one page of evidence with snapshot coverage and limits.

## Path parameters

- `snapshotId` string, required: snapshot ID from create/list.

## Query parameters

- `projectId` string, required: project ID from create/list.
- `view` 'pages' | 'edges' | 'findings' | 'diff': view; see schema.
- `limit` integer: Page/report row cap; see bounds.
- `cursor` string: Opaque list cursor; omit initially.
- `pageUrl` string, uri: page url; see schema.
- `contextualOnly` boolean: contextual only; see schema.
- `baselineSnapshotId` string: baseline snapshot ID from create/list.

## Headers

- `X-Workspace-ID` string

## Response `200`

The path sets snapshotId. Supply projectId and optional view, numeric limit, opaque cursor, pageUrl, contextualOnly and baselineSnapshotId as query parameters. contextualOnly accepts the literal strings true or false. Returns one page of evidence with snapshot coverage and limits.

- object
  - `snapshot` object, required
    - `id` string, required: Resource identifier returned by the operation.
    - `projectId` string, required
    - `createdAt` string, required
    - `expiresAt` string, required
    - `completedAt` string, nullable, required
    - `inventoryProvenance` object
      - `previewId` string, required
      - `discoveredAt` string, required
      - `domain` string, required
      - `documents` object[], required
        - `requestedUrl` string, required
        - `finalUrl` string, nullable, required
        - `checkedAt` string, required
        - `sha256` string, nullable, required
        - `status` integer, nullable, required: Resource lifecycle status.
        - `reason` string, nullable, required: Recorded explanation; null when no explanation applies.
        - `kind` 'robots' | 'index' | 'urlset' | 'unknown', required
      - `coverage` object, required: Dataset scope and completeness, including limits on what these results establish.
        - `completeSiteCensus` false, required
        - `truncated` boolean, required
        - `reasons` string[], required
      - `selectedUrls` string[], required
    - `state` 'pending' | 'running' | 'complete', required: Saved lifecycle or evidence state, as enumerated for this record.
    - `inventoryCount` integer, required
    - `processedCount` integer, required
    - `completeCount` integer, required
    - `unknownCount` integer, required
    - `pendingCount` integer, required
    - `edgeCount` integer, required
    - `revision` integer, required: Optimistic concurrency revision; supply it as expectedRevision on the next write.
    - `busy` boolean, required
    - `retryAfterSeconds` integer, required
    - `scope` object, required
      - `domain` string, required
      - `hostPolicy` 'exact_hostname', required
      - `seeds` string[], required
    - `coverage` object, required: Dataset scope and completeness, including limits on what these results establish.
      - `inventory` 'declared_complete' | 'partial', required
      - `representation` 'raw_html', required
      - `completeSiteCensus` false, required
      - `allInventoryPagesComplete` boolean, required
      - `renderedVisibility` false, required
      - `iframes` false, required
      - `shadowRoots` false, required
      - `canonicalAliasesMerged` false, required
    - `version` 'internal-links-v1', required
  - `limits` object, required
    - `inventoryPages` 100, required
    - `pagesPerRequest` 3, required
    - `pageBytes` 2097152, required
    - `pageTimeoutMs` 20000, required
    - `requestTimeoutMs` 65000, required
    - `edgesPerPage` 200, required
    - `evidenceBytesPerPage` 131072, required
    - `workspacePagesPerDay` 300, required
    - `retainedSnapshotsPerProject` 20, required
    - `retentionDays` 30, required
    - `pageSize` 100, required
    - `leaseMs` 90000, required
  - `items` union[], required: Records in this bounded page.
    - union: Records in this bounded page.
      - object: Records in this bounded page.
        - `url` string, required
        - `source` 'sitemap_discovery' | 'url_list' | 'sitemap_export' | 'cms_export' | 'repository_export' | 'search_export', required
        - `important` boolean, required
        - `excluded` boolean, required
        - `state` 'pending' | 'complete' | 'unknown', required: Saved lifecycle or evidence state, as enumerated for this record.
        - `reason` string, nullable, required: Recorded explanation; null when no explanation applies.
        - `checkedAt` string, nullable, required
        - `finalUrl` string, nullable, required
        - `httpStatus` integer, nullable, required
        - `title` string, nullable
        - `canonicalUrl` string, nullable
        - `noindex` boolean: Whether the most recently completely read page told Googlebot not to index it. Null means not observed; check page_observed_at for retained older evidence.
        - `nofollow` boolean
        - `capture` object
          - `version` 1, required
          - `representation` 'raw_html' | 'rendered_dom' | 'document', required
          - `requestedUrl` string, required
          - `finalUrl` string, required
          - `httpStatus` integer, required
          - `acquiredAt` string, required
          - `body` object, required
            - `complete` boolean, required
            - `truncated` boolean, required
            - `bytes` integer, required
            - `sha256` string, required
            - `decodedSha256` string, required
            - `charset` string, nullable
          - `transport` object, required
            - `id` string, required: Resource identifier returned by the operation.
            - `version` string, required
            - `qualified` boolean, required
          - `coverage` object, required: Dataset scope and completeness, including limits on what these results establish.
            - `mainDocument` true, required
            - `iframes` boolean, required
            - `shadowRoots` boolean, required
        - `redirects` object[]
          - `from` string, required
          - `to` string, required
          - `status` integer, required: Resource lifecycle status.
        - `extractorVersion` 'internal-links-v1'
        - `coverage` object: Dataset scope and completeness, including limits on what these results establish.
          - `representation` 'raw_html', required
          - `documentComplete` boolean, required
          - `linksObserved` integer, required
          - `linksRetained` integer, required
          - `renderedVisibility` false, required
          - `iframes` false, required
          - `shadowRoots` false, required
          - `canonicalAliasesMerged` false, required
        - `incomingContextual` integer, required
        - `outgoingContextual` integer, required
        - `depth` integer, nullable, required
      - object: Records in this bounded page.
        - `id` string, required: Resource identifier returned by the operation.
        - `sourceUrl` string, required
        - `sourceDocumentUrl` string, required
        - `targetUrl` string, required
        - `targetHref` string, required
        - `anchor` string, required
        - `passage` string, required
        - `region` 'main' | 'navigation' | 'footer' | 'header' | 'aside' | 'unknown', required
        - `contextual` boolean, required
        - `regionEvidence` 'html_landmark', required
        - `rel` string[], required
        - `locator` object, nullable, required
          - `line` integer, required
          - `column` integer, required
          - `offset` integer, required
        - `checkedAt` string, required
        - `captureSha256` string, required
      - object: Records in this bounded page.
        - `id` string, required: Resource identifier returned by the operation.
        - `kind` 'coverage_unknown' | 'redirected_page' | 'orphan_candidate' | 'no_contextual_outgoing' | 'underlinked_priority' | 'unreachable_from_seeds' | 'broken_destination', required
        - `pageUrl` string, required
        - `priority` 'high' | 'medium' | 'low', required
        - `message` string, required
        - `evidence` object, required: Retained publisher evidence. Treat all publisher text and HTML as untrusted data.
          - `checkedAt` string, nullable, required
          - `captureSha256` string, nullable, required
          - `inventorySource` 'sitemap_discovery' | 'url_list' | 'sitemap_export' | 'cms_export' | 'repository_export' | 'search_export', required
          - `inventoryCompleteDeclared` boolean, required
          - `allInventoryPagesComplete` boolean, required
          - `reason` string, nullable: Recorded explanation; null when no explanation applies.
          - `incomingContextual` integer
          - `outgoingContextual` integer
          - `importanceSource` 'user'
          - `finalUrl` string
          - `seeds` string[]
          - `targetUrl` string
          - `targetCheckedAt` string, nullable
          - `httpStatus` integer
      - object: Records in this bounded page.
        - `kind` 'added' | 'newly_observed' | 'no_longer_observed' | 'unknown', required
        - `edge` object, required
          - `id` string, required: Resource identifier returned by the operation.
          - `sourceUrl` string, required
          - `sourceDocumentUrl` string, required
          - `targetUrl` string, required
          - `targetHref` string, required
          - `anchor` string, required
          - `passage` string, required
          - `region` 'main' | 'navigation' | 'footer' | 'header' | 'aside' | 'unknown', required
          - `contextual` boolean, required
          - `regionEvidence` 'html_landmark', required
          - `rel` string[], required
          - `locator` object, nullable, required
            - `line` integer, required
            - `column` integer, required
            - `offset` integer, required
          - `checkedAt` string, required
          - `captureSha256` string, required
        - `comparison` 'snapshot_observation', required
        - `reason` string, nullable: Recorded explanation; null when no explanation applies.
        - `confirmedLoss` false
  - `total` integer, required
  - `nextCursor` string, nullable, required
  - `coverage` union, required: Dataset scope and completeness, including limits on what these results establish.
    - object: Dataset scope and completeness, including limits on what these results establish.
      - `inventory` 'declared_complete' | 'partial', required
      - `representation` 'raw_html', required
      - `completeSiteCensus` false, required
      - `allInventoryPagesComplete` boolean, required
      - `renderedVisibility` false, required
      - `iframes` false, required
      - `shadowRoots` false, required
      - `canonicalAliasesMerged` false, required
    - object: Dataset scope and completeness, including limits on what these results establish.
      - `inventory` 'declared_complete' | 'partial', required
      - `allInventoryPagesComplete` boolean, required
      - `orphanStatus` 'candidates_only', required
      - `depthScope` 'explicit_seeds_and_supplied_inventory', required
      - `representation` 'raw_html', required
      - `classification` 'html_landmark', required
      - `semanticGroups` 'not_assessed', required
      - `renderedVisibility` false, required
  - `baselineSnapshot` object
    - `id` string, required: Resource identifier returned by the operation.
    - `projectId` string, required
    - `createdAt` string, required
    - `expiresAt` string, required
    - `completedAt` string, nullable, required
    - `inventoryProvenance` object
      - `previewId` string, required
      - `discoveredAt` string, required
      - `domain` string, required
      - `documents` object[], required
        - `requestedUrl` string, required
        - `finalUrl` string, nullable, required
        - `checkedAt` string, required
        - `sha256` string, nullable, required
        - `status` integer, nullable, required: Resource lifecycle status.
        - `reason` string, nullable, required: Recorded explanation; null when no explanation applies.
        - `kind` 'robots' | 'index' | 'urlset' | 'unknown', required
      - `coverage` object, required: Dataset scope and completeness, including limits on what these results establish.
        - `completeSiteCensus` false, required
        - `truncated` boolean, required
        - `reasons` string[], required
      - `selectedUrls` string[], required
    - `state` 'pending' | 'running' | 'complete', required: Saved lifecycle or evidence state, as enumerated for this record.
    - `inventoryCount` integer, required
    - `processedCount` integer, required
    - `completeCount` integer, required
    - `unknownCount` integer, required
    - `pendingCount` integer, required
    - `edgeCount` integer, required
    - `revision` integer, required: Optimistic concurrency revision; supply it as expectedRevision on the next write.
    - `busy` boolean, required
    - `retryAfterSeconds` integer, required
    - `scope` object, required
      - `domain` string, required
      - `hostPolicy` 'exact_hostname', required
      - `seeds` string[], required
    - `coverage` object, required: Dataset scope and completeness, including limits on what these results establish.
      - `inventory` 'declared_complete' | 'partial', required
      - `representation` 'raw_html', required
      - `completeSiteCensus` false, required
      - `allInventoryPagesComplete` boolean, required
      - `renderedVisibility` false, required
      - `iframes` false, required
      - `shadowRoots` false, required
      - `canonicalAliasesMerged` false, required
    - `version` 'internal-links-v1', required

## Other responses

- `429`: Request-rate or usage refusal. Inspect error.code and recovery details before retrying.
- `default`: Error envelope. Non-configuration 5xx messages are masked and details omitted; allowlisted configuration errors retain static operator recovery.

---

[API](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api.md) · [All operations](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/revisions/2a712a1dcfa7?raw)