POST Completed

The "completed" event occurs once the scan process has been completed and the scan finished successfully.

Successful scans provide you all the output information from the scan process. The data that is attached to the request body contains the following parts:

Name Description

status

The current status of the scan.

Integer

Possible values:
0: Success
1: Error
2: CreditsChecked
3: Indexed

developerPayload

The developer payload that was provided in the submit method.

String

Max Length: 512 characters

scannedDocument.scanId

The unique scan id provided by you.

String

scannedDocument.totalWords

Number of copied words from the submitted content.

Unsigned Integer

scannedDocument.totalExcluded

Number of excluded words in the submitted content.

Unsigned Integer

scannedDocument.credits

Overall credits used for the scan.

Integer

scannedDocument.creationTime

The creation time of the scan.

String (datetime)

Timezone: UTC+0

results.internet.id

Unique result ID to identify the result.

String

results.internet.title

Document title. Mostly extracted from the document content.

String

results.internet.introduction

Document brief introduction. Mostly extracted from the document content.

String

results.internet.matchedWords

Total matched words between this result and the scanned document.

Unsigned Integer

results.internet.url

Public URL of the resource.

String (uri)

results.database.id

Unique result ID to identify this result.

Integer

results.database.title

Document title. Mostly extracted from the document content.

String

results.database.introduction

Document brief introduction. Mostly extracted from the document content.

String

results.database.matchedWords

Total matched words between this result and the scanned document.

Unsigned Integer

results.database.scanId

In case a result was found in the Copyleaks internal database, and was submitted by you, this will show the scan id of the specific result. Otherwise, this field will remain empty.

String

results.batch.id

Unique result ID to identify this result.

String

results.batch.title

Document title. Mostly extracted from the document content.

String

results.batch.introduction

Document brief introduction. Mostly extracted from the document content.

String

results.batch.matchedWords

Total matched words between this result and the scanned document.

Unsigned Integer

results.batch.scanId

The batch id that is unique for all scans in this batch.

String

results.score.identicalWords

Number of exact words in the text.

Unsigned Integer

results.score.minorChangedWords

Number of nearly identical words with small differences like 'slow' and 'slowly'.

Unsigned Integer

results.score.relatedMeaningWords

Number of paraphrased words showing similar ideas with different words.

Unsigned Integer

results.score.aggregatedScore

The percentage of similar words from all results. The calculation does not include excluded references, quotations, etc...

Unsigned float

Example

{
  "status": 0,
  "developerPayload": "Custom developer payload",
  "scannedDocument": {
    "scanId":"string"
    "totalWords": 0,
    "totalExcluded": 0,
    "credits": 0,
    "creationTime": "string"
  },
  "results": {
    "internet": [
      {
        "id": "string",
        "title": "string",
        "introduction": "string",
        "matchedWords": 0,
        "url": "string"
      }
    ],
    "database": [
      {
        "id": "string",
        "title": "string",
        "introduction": "string",
        "matchedWords": 0,
        "scanId": "string"
      }
    ],
    "batch": [
      {
        "id": "string",
        "title": "string",
        "introduction": "string",
        "matchedWords": 0,
        "scanId": "string"
      }
    ],
    "score": {
      "identicalWords": 0,
      "minorChangedWords": 0,
      "relatedMeaningWords": 0,
      "aggregatedScore": 0
    }
  },
  "downloadableReport": {
    "status": "Success = 0",
    "report": "string"
  }
}