Results

Crawled Version

A snapshot of the submitted document. It shows how Copyleaks viewed your submitted file.

Webhook HTTP verb

The HTTP verb for this webhook is upon developer request. You need to specify your verb while executing the Export method See crawledVersion.verb field.

The crawled version is available in textual format, and if the properties.includeHtml field (in the submit method) is set to true, it is also in HTML format.

metadata object

words integer

Number of words in the text.

excluded integer

Number of excluded words in the text.

text object

value string

The crawled version of the submitted text.

exclude object

starts array

The start position of the section to exclude.

lengths array

The length, in characters, of the section to exclude.

reasons array

The reason why this section was excluded.

pages object

startPosition array

A list of pages start positions of the text.

Example

{
  "metadata": {
    "words": 30,
    "excluded": 2
  },
  "html": {
    "value": "<html><body><h1>Example Domain</h1><p>This domain is established to be used for illustrative examples in documents.</body></html>",
    "exclude": {
      "starts": [
        16
      ],
      "lengths": [
        14
      ],
      "reasons": [
        3
      ],
      "groupIds": [
        1
      ]
    }
  },
  "text": {
    "value": "Example Domain This domain is established to be used for illustrative examples in documents.",
    "exclude": {
      "starts": [
        0
      ],
      "lengths": [
        14
      ],
      "reasons": [
        3
      ]
    },
    "pages": {
      "startPosition": [
        0
      ]
    }
  }
}

Next Steps

Export Method Learn how to use the export method to retrieve detailed scan results.

How to Display Scan Reports Understand how to present crawled versions and other scan data to your users.