scan | object | Required | additional fields rejected |
scan.version | string | Required | must equal "internal-link-scan-v1" |
scan.id | string | Required | Resource identifier returned by the operation. minLength: 1; maxLength: 200 |
scan.projectId | string | Required | Identifier returned by the related operation. minLength: 1; maxLength: 200 |
scan.domain | string | Required | |
scan.homepage | string | Required | |
scan.state | string | Required | Saved lifecycle or evidence state, as enumerated for this record. values: "queued", "running", "paused", "cancelled", "complete", "limit_reached", "failed" |
scan.reason | string / null | Required | Recorded explanation; null when no explanation applies. |
scan.createdAt | string | Required | |
scan.updatedAt | string | Required | |
scan.expiresAt | string | Required | |
scan.completedAt | string / null | Required | |
scan.revision | integer | Required | Optimistic concurrency revision; supply it as expectedRevision on the next write. minimum: 0; maximum: 9007199254740991 |
scan.controlRevision | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.discoveredCount | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.completeCount | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.unknownCount | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.pendingCount | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.admittedCount | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.edgeCount | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.excludedReferences | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.exclusions | object | Required | |
scan.nextEligibleAt | string | Required | |
scan.discovery | object | Required | additional fields rejected |
scan.discovery.state | string | Required | Saved lifecycle or evidence state, as enumerated for this record. values: "pending", "complete" |
scan.discovery.coverage | object | Optional | Dataset scope and completeness, including limits on what these results establish. additional fields rejected |
scan.discovery.coverage.completeSiteCensus | boolean | Required | must equal false |
scan.discovery.coverage.truncated | boolean | Required | |
scan.discovery.coverage.reasons | array | Required | |
scan.discovery.documents | array | Optional | maxItems: 13 |
scan.discovery.documents[].requestedUrl | string | Required | |
scan.discovery.documents[].finalUrl | string / null | Required | |
scan.discovery.documents[].checkedAt | string | Required | |
scan.discovery.documents[].sha256 | string / null | Required | |
scan.discovery.documents[].status | integer / null | Required | Resource lifecycle status. |
scan.discovery.documents[].reason | string / null | Required | Recorded explanation; null when no explanation applies. |
scan.discovery.documents[].kind | string | Required | values: "robots", "index", "urlset", "unknown" |
scan.coverage | object | Required | Dataset scope and completeness, including limits on what these results establish. additional fields rejected |
scan.coverage.inventory | string | Required | must equal "partial" |
scan.coverage.completeSiteCensus | boolean | Required | must equal false |
scan.coverage.representation | string | Required | must equal "raw_html" |
scan.coverage.frontierTruncated | boolean | Required | |
scan.coverage.renderedVisibility | boolean | Required | must equal false |
scan.coverage.canonicalAliasesMerged | boolean | Required | must equal false |
scan.usage | object | Required | additional fields rejected |
scan.usage.unit | string | Required | must equal "admitted_page" |
scan.usage.period | string | Required | |
scan.usage.limit | number | Required | must equal 300 |
scan.usage.used | integer | Required | minimum: 0; maximum: 9007199254740991 |
scan.usage.resetsAt | string | Required | |
limits | object | Required | additional fields rejected |
limits.pagesPerRun | number | Required | must equal 300 |
limits.workspacePagesPerDay | number | Required | must equal 300 |
limits.retainedRunsAndSnapshotsPerProject | number | Required | must equal 20 |
limits.retentionDays | number | Required | must equal 30 |
limits.pageBytes | number | Required | must equal 2097152 |
limits.pageTimeoutMs | number | Required | must equal 20000 |
limits.leaseMs | number | Required | must equal 90000 |
limits.maxAttempts | number | Required | must equal 3 |
limits.edgesPerPage | number | Required | must equal 200 |
limits.pageSize | number | Required | must equal 100 |
items | array | Required | Records in this bounded page. maxItems: 100 |
items[].url | string | Required | |
items[].source | string | Required | values: "homepage", "sitemap", "link" |
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[].discoveredDepth | integer | Required | minimum: 0; maximum: 9007199254740991 |
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: "homepage", "sitemap", "link" |
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 |
total | integer | Required | minimum: 0; maximum: 9007199254740991 |
nextCursor | string / null | Required | |
coverage | object | Required | Dataset scope and completeness, including limits on what these results establish. additional fields rejected |
coverage.inventory | string | Required | must equal "partial" |
coverage.completeSiteCensus | boolean | Required | must equal false |
coverage.representation | string | Required | must equal "raw_html" |
coverage.frontierTruncated | boolean | Required | |
coverage.renderedVisibility | boolean | Required | must equal false |
coverage.canonicalAliasesMerged | boolean | Required | must equal false |