GET v1/businesses/{ProcessId}/result
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:
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
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
URL |
The suspected URL |
URI | Available when the result originates online |
Percents |
Percent of copied text from your content |
integer | |
NumberOfCopiedWords |
Number of copied words from your content |
integer | |
ComparisonReport |
Link to a full comparison report |
URI | Access is given only with Authorization header |
CachedVersion |
The cached text of your scan |
URI | Access is given only with Authorization header |
Title |
The specific result title |
text/plain | |
Introduction |
The specific result introduction |
text/plain | |
EmbededComparison |
Embeded comaprison report to include on your platform |
URI | Access is given only with Authorization header |
Response Formats
application/json, text/json
Sample:
[ { "URL":"http://example.com/", "Percents":14, "NumberOfCopiedWords":15, "ComparisonReport":"https://api.copyleaks.com/v1/downloads/comparison?rid=1493025", "CachedVersion":"https://api.copyleaks.com/v1/downloads/result-text?rid=1493025", "Title":"Title of the file", "Introduction":"This is how the text starts.", "EmbededComparison":"https://copyleaks.com/compare/d69167b7-670b-491f-827f-46ba5ffd43a0/1493025" } ]
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.