Scan Completed
The completed event occurs once the scan process has been completed and the scan finished successfully.
The current status of the scan. Possible values: 0 (Success), 1 (Error), 2 (CreditsChecked), 3 (Indexed)
The developer payload that was provided in the submit method.
<= 512 characters
scannedDocument object
General information about the scanned document.
The unique scan id provided by you.
Unsigned Integer
Total number of words found in the scanned text.
Unsigned Integer
Number of excluded words in the submitted content.
Overall credits used for the scan.
The creation time of the scan.
Timezone: UTC+0
metadata object
The submitted url after all http redirects.
Extracted canonical url from the scanned document.
Publication date of the scanned document.
Creation date of the scanned document.
Last modification date of the scanned document.
Scanned document author.
Scanned document organization.
Scanned document filename.
results object
A list of all the results that were found.
internet object
Unique result ID to identify the result.
Document title. Mostly extracted from the document content.
Document brief introduction. Mostly extracted from the document content.
Unsigned Integer
Total matched words between this result and the scanned document.
Public URL of the resource.
metadata object
database object
Unique result ID to identify this result.
Document title. Mostly extracted from the document content.
Document brief introduction. Mostly extracted from the document content.
Unsigned Integer
Total matched words between this result and the scanned document.
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.
metadata object
Final result url after all http redirects.
Extracted canonical url from the result.
Publication date of the result.
Creation date of the result.
Last modification date of the result.
Result author.
Result organization.
Result filename.
tags array[object]
Unique ID that signifies the type of result tag.
A simple name for this tag.
Short text describing this tag.
batch object
Unique result ID to identify this result.
Document title. Mostly extracted from the document content.
Document brief introduction. Mostly extracted from the document content.
Unsigned Integer
Total matched words between this result and the scanned document.
The batch id that is unique for all scans in this batch.
metadata object
Final result url after all http redirects.
Extracted canonical url from the result.
Publication date of the result.
Creation date of the result.
Last modification date of the result.
Result author.
Result organization.
Result filename.
tags array[object]
Unique ID that signifies the type of result tag.
A simple name for this tag.
Short text describing this tag.
repositories object
Unique result ID to identify this result.
Document title. Mostly extracted from the document content.
Document brief introduction. Mostly extracted from the document content.
Unsigned Integer
Total matched words between this result and the scanned document.
The repository Id that has the result.
The scanId of the matched results in the repository.
metadata object
Final result url after all http redirects.
Extracted canonical url from the result.
Publication date of the result.
Creation date of the result.
Last modification date of the result.
Result author.
Result organization.
Result filename.
Email of the user which added this document to the repository.
tags array[object]
Unique ID that signifies the type of result tag.
A simple name for this tag.
Short text describing this tag.
score object
The aggregated score of all results.
Unsigned Integer
Number of words which matched exactly
Unsigned Integer
Number of nearly identical words with small differences like ‘slow’ and ‘slowly’.
Unsigned Integer
Number of paraphrased words showing similar ideas with different words.
Unsigned float
The percentage of similar words from all results. The calculation does not include excluded references, quotations, etc…
notifications object
A list of all the notifications that were found.
alerts array[object]
A list of scan alerts that were detected in the scan. See more about Alert Types
Scan alert category.
Scan alert code. The code is unique for each scan alert.
Scan alert human-readable title.
Provides human-readable information about the scan alert.
Url to a resource describing the specific scan alert.
Unsigned Integer
Specifies the importance of the scan alert.
Possible values:
0 : Very Low
1 : Low
2 : Medium
3 : High
4 : Very High
Additional data about the scan alert. Supplied as a json string.
Example
Section titled “Example”{ "status": 0, "developerPayload": "Custom developer payload", "scannedDocument": { "scanId": "string", "totalWords": 0, "totalExcluded": 0, "credits": 0, "creationTime": "string", "metadata": { "finalUrl": "string", "canonicalUrl": "string", "author": "string", "organization": "string", "filename": "string", "publishDate": "string", "creationDate": "string", "lastModificationDate": "string" } }, "results": { "internet": [ { "id": "string", "title": "string", "introduction": "string", "matchedWords": 0, "url": "string", "metadata": { "finalUrl": "string", "canonicalUrl": "string", "author": "string", "organization": "string", "filename": "string", "publishDate": "string", "creationDate": "string", "lastModificationDate": "string" } } ], "database": [ { "id": "string", "title": "string", "introduction": "string", "matchedWords": 0, "scanId": "string", "metadata": { "finalUrl": "string", "canonicalUrl": "string", "author": "string", "organization": "string", "filename": "string", "publishDate": "string", "creationDate": "string", "lastModificationDate": "string" } } ], "batch": [ { "id": "string", "title": "string", "introduction": "string", "matchedWords": 0, "scanId": "string", "metadata": { "finalUrl": "string", "canonicalUrl": "string", "author": "string", "organization": "string", "filename": "string", "publishDate": "string", "creationDate": "string", "lastModificationDate": "string" } } ], "repositories": [ { "id": "string", "title": "string", "introduction": "string", "matchedWords": 0, "repositoryId": "string", "scanId": "string", "metadata": { "finalUrl": "string", "canonicalUrl": "string", "author": "string", "organization": "string", "filename": "string", "publishDate": "string", "creationDate": "string", "lastModificationDate": "string", "submittedBy": "string" } } ], "score": { "identicalWords": 0, "minorChangedWords": 0, "relatedMeaningWords": 0, "aggregatedScore": 0 } }, "downloadableReport": { "status": "Success = 0", "report": "string" }, "notifications": { "alerts": [ { "category": 2, "code": "string", "title": "string", "message": "string", "helpLink": "string", "severity": 0, "additionalData": "string" } ] }}