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.

Request

Name Description

scanId Required

The scan ID of the specific scan.

String
Length: 3-36 characters.

resultId Required

The result ID of the specific result.

You will get the result ID through the completed webhook.

String

Request Example

curl -XGET -H 'Authorization: Bearer YOUR-LOGIN-TOKEN' 'https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID'
GET https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID

Authorization: Bearer YOUR-LOGIN-TOKEN;
import requests

headers = {
    'Authorization': 'Bearer YOUR-LOGIN-TOKEN',
}

response = requests.get('https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID', headers=headers)

using (var httpClient = new HttpClient())
{
    using (var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID"))
    {
        request.Headers.TryAddWithoutValidation("Authorization", "Bearer YOUR-LOGIN-TOKEN"); 

        var response = await httpClient.SendAsync(request);
    }
}
var request = require('request');

var headers = {
    'Authorization': 'Bearer YOUR-LOGIN-TOKEN'
};

var options = {
    url: 'https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Authorization' => 'Bearer YOUR-LOGIN-TOKEN'
);
$response = Requests::get('https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID', $headers);

Response

Codes

Status Code Description
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