Crawled Version

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.

We recommend you use the HTTP verb PUT. It will allow Copyleaks to override an existing file as needed.

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

Show metadata properties

words

integer

Number of words in the text.

excluded

integer

Number of excluded words in the text.

text

object

Show text properties

value

string

The crawled version of the submitted text.

exclude

object

Show exclude properties

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

Show pages properties

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
      ]
    }
  }
}

Webhook HTTP verb

Example

Next Steps

Export Method

How to Display Scan Reports

​Webhook HTTP verb

​Example

​Next Steps

Export Method

How to Display Scan Reports

Webhook HTTP verb

Example

Next Steps