GET v2/businesses/{ProcessId}/result

Depreciation

Copyleaks V1 API has been deprectaed and will reach it's end of life on July 1st 2020.

See newer version documentation - Copyleaks V3 API.

Get the results using the process Id. See exactly where your submitted content has been used, and get a full report showing the copied parts.

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 Information

URI Parameters

Name Description Type Additional information
ProcessId

The Id of the process that you would like to receive its results

 globally unique identifier

Required

Response Information

Response Formats

application/json, text/json

Sample: 
{
   "paidCredits":8,
   "results":[
      {
         "id":123,
         "url":"http://example.com/",
         "totalMatchedPercents":15,
         "totalMatchedWords":100,
         "title":"Title of the file",
         "introduction":"This is how the text starts.",
         "report":"https://copyleaks.com/compare-embed/businesses/0000ca57-c9fe-42e8-afcd-385f492b855e/123/1/1"
      }
   ]
}

Resource Description

Name Description Type Additional information
paidCredits

Overall credits used for the scan

integer
results
Name Description Type Additional information
id

The ID of the specific result.

 integer
url

Link to the result

URI Optional. Available when the result originates online.
totalMatchedPercents

Percent of copied text from your content

 integer
totalMatchedWords

Number of copied words from your content

 integer
Title

The specific result title

 string
Introduction

The specific result introduction

 string
report

Comaprison report between your submitted content and the specific result

 URI

Common Errors

Error Code Error Message
27 Unknown process id!
26 The request cannot be completed because the process is still running.
37 Authorization has been denied for this request.

For more information, see the full errors list.

Deprecated Versions