BOOK A DEMO
LOGIN
Homekeyboard_arrow_rightDocumentationkeyboard_arrow_rightVersion 3keyboard_arrow_rightPlagiarism Checkkeyboard_arrow_rightDownloadskeyboard_arrow_rightResult
GET

/v3/downloads/{scanId}/results/{resultId}

Get access to the raw information of the specific result including the percentage of plagiarism, the exact match’s location in the text, and more. Use this method if you would like to build your own custom-designed report, rather than using the Copyleaks standard report.

Testing purposes only!
This endpoint is for integration testing and verification only. Don't use this endpoint in the production environment.

For the production environment, use the Export method .
lock You need to login with a user and api key in order to access this method.
Add this HTTP header to your request:
Authorization: Bearer <Your-Login-Token>
Not sure how to generate your login token? Read here .

Request

URL Parameters

Name
Description
scanIdREQUIRED
The scan ID of the specific scan.
String
Length: 3-36 characters.
resultIdREQUIRED
The result ID of the specific result.

You will get the result ID through the completed webhook.

String

Request Example

RAW
cURL
Python
C#
Node.js
PHP
GET
https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID
Headers
Body

Response

Codes

Status Code
Description
Example
200
The command was executed.
401
Authorization has been denied for this request

Example

{
  "statistics": {
    "identical": 0,
    "minorChanges": 0,
    "relatedMeaning": 0
  },
  "text": {
    "value": "Hello world!",
    "pages": {
      "startPosition": [
        0
      ]
    },
    "comparison": {
      "identical": {
        "source": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        },
        "suspected": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        }
      },
      "minorChanges": {
        "source": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        },
        "suspected": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        }
      },
      "relatedMeaning": {
        "source": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        },
        "suspected": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        }
      }
    }
  },
  "html": {
    "value": "<HTML><body><h3>Hello world!</h3></body></HTML>",
    "comparison": {
      "identical": {
        "groupId": [
          0
        ],
        "source": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        },
        "suspected": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        }
      },
      "minorChanges": {
        "groupId": [
          0
        ],
        "source": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        },
        "suspected": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        }
      },
      "relatedMeaning": {
        "groupId": [
          0
        ],
        "source": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        },
        "suspected": {
          "chars": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          },
          "words": {
            "starts": [
              0
            ],
            "lengths": [
              1
            ]
          }
        }
      }
    }
  }
}

Description

Name
Description
statistics.identical
Number of exact words in the text.
Unsigned Integer
statistics.minorChanges
Number of nearly identical words with small differences like slow becomes slowly.
Unsigned Integer
statistics.relatedMeaning
Number of paraphrased words stating similar ideas with different words.
Unsigned Integer
text.value
The text of the specific result that was found to contain similar content to the submitted text.
String
text.pages.startPosition
A list of pages' start positions of the text, the first startPostion is the start position of the first page.
Integer Array
text.comparison.identical.source.chars.starts
A list of text match groups and their start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.identical.source.chars.lengths
A list of text match groups and their lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.identical.source.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
text.comparison.identical.source.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array
text.comparison.identical.suspected.chars.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
text.comparison.identical.suspected.chars.lengths
A list of lengths text match groups, the length of the first match is the first element in the list.
Integer Array
text.comparison.identical.suspected.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
text.comparison.identical.suspected.words.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.source.chars.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.source.chars.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.source.words.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.source.words.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.suspected.chars.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.suspected.chars.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.suspected.words.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.minorChanges.suspected.words.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.source.chars.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.source.chars.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.source.words.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.source.words.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.suspected.chars.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.suspected.chars.lengths
A list of text match groups lengths, the length of the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.suspected.words.starts
A list of text match groups start positions, the start position for the first match is the first element in the list.
Integer Array
text.comparison.relatedMeaning.suspected.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array
html.value
The html of the specific result that was found to contain similar content to the submitted text.
String
html.comparison.identical.groupId
The group identifier for a match, combining all matches with the same group identifier will result in one consecutive match.
Integer Array
html.comparison.identical.source.chars.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.identical.source.chars.lengths
A list of lengths text match groups, the length of the first match is the first element in the list.
Integer Array
html.comparison.identical.source.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.identical.source.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array
html.comparison.identical.suspected.chars.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.identical.suspected.chars.lengths
A list of lengths text match groups, the length of the first match is the first element in the list.
Integer Array
html.comparison.identical.suspected.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.identical.suspected.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array
html.comparison.minorChanges.groupId
The group identifier for a match, combining all matches with the same group identifier will result in one consecutive match
Integer Array
html.comparison.minorChanges.source.chars.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.minorChanges.source.chars.lengths
A list of lengths text match groups, the length of the first match is the first element in the list.
Integer Array
html.comparison.minorChanges.source.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.minorChanges.source.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array
html.comparison.minorChanges.suspected.chars.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.minorChanges.suspected.chars.lengths
A list of lengths text match groups, the length of the first match is the first element in the list.
Integer Array
html.comparison.minorChanges.suspected.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.minorChanges.suspected.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array
html.comparison.relatedMeaning.groupId
The group identifier for a match, combining all matches with the same group identifier will result in one consecutive match
Integer Array
html.comparison.relatedMeaning.source.chars.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.relatedMeaning.source.chars.lengths
A list of lengths text match groups, the length of the first match is the first element in the list.
Integer Array
html.comparison.relatedMeaning.source.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.relatedMeaning.source.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array
html.comparison.relatedMeaning.suspected.chars.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.relatedMeaning.suspected.chars.lengths
A list of lengths text match groups, the length of the first match is the first element in the list.
Integer Array
html.comparison.relatedMeaning.suspected.words.starts
A list of start positions text match groups, the start position for the first match is the first element in the list.
Integer Array
html.comparison.relatedMeaning.suspected.words.lengths
A list of lengths text match groups, the length of the first match is the first element in the list
Integer Array

Other resources:

  • Exponential Backoff - Algorithm that helps applications define a retry strategy for consuming a network service.
stack-overflow_icon.png

Do you have a technical question?

Use stackoverflow.com to get help from our development team and other Copyleaks users.

Ask a Question

PRODUCTS

Scans
Pricing
Copyleaks.com

RESOURCES

Documentation
Plagiarism Report
Help Center
System Status
Security

ABOUT

About us
Careers
Terms of Use
Privacy Policy
Sitemap

Copyleaks, Inc.

700 Canal St.
Stamford, CT 06902 USA

[email protected]

Copyleaks, Inc. All rights reserved. Use of this website signifies your agreement to the Terms of Use.

Copy