PageSegment

A search match located on a page of a paginated document, such as a PDF.

typestringrequired

The segment type discriminator.

Possible values: [page]

pageintegerrequired

The 1-based page number the match occurred on.

Possible values: >= 1

Example: 3

highlightstring[]required

Matched text fragments from this page, using the same marking convention as searchExtra.highlight.

PageSegment

{
  "type": "page",
  "page": 3,
  "highlight": [
    "string"
  ]
}