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