GET v1/education/{ProcessId}/info

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 information about your scan, using your process Id, including number of paid credits, word count and more.

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 information about

globally unique identifier

Required

Response Information

Resource Description

Information about the specified 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).

WordCount

The number of words that were submitted for a scan in your process

unsigned integer

RequestTime

The request's creation time

string
EndTime

The time when the scan has been completed

string
PaidCredits

The number of credits that has been used for the scan of the specific process

unsigned integer
CustomFields

You can add custom payload to the request headers. The payload is stored in a 'dictionary' representing a collection of string key and string value pairs.

Dictionary(String,String) Read here for more information.

Response Formats

application/json, text/json

Sample:
{
   "status":"Finished",
   "wordsCount":65,
   "requestTime":"2018-05-10T21:45:16.5516674",
   "endTime":"2018-05-10T21:45:20.4721994",
   "paidCredits":1,
   "customFields":[
   ],
   "metadata":[
   ],
   "excludedRanges":[
   ]
}

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.