GET v1/academic/{ProcessId}/status

Get the scan progess details using your process Id

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

NameDescriptionTypeAdditional information
ProcessId

The id of the process that you would like to to receive its status

globally unique identifier

Required

Response Information

Resource Description

The status of the requeted process

NameDescriptionTypeAdditional information
Status

The current status of the requested process.

string

Optional values: "Processing" (the process is still being processed by Copyleaks) and "Finished" (Copyleaks finished processing your request).

ProgressPercents

The progress status in percents.

unsigned integer

Values range: 0-100

Response Formats

application/json, text/json

Sample:
{
  "Status": "Processing",
  "ProgressPercents": 50
}

Common Errors

Error Code Error Message
27 Unknown process id!
37 Authorization has been denied for this request.

For more information, see the full errors list.