reports/status/{id}

Check report status, progress and report datetimes (created, modified, notified)

Resource URL

GET | POST https://plagiarismsearch.com/api/v3/reports/status/{id}

Parameters

Parameter	Type	Description	Optional	Default
id	integer	Report ID. Used in the request URL.

Example

GET https://plagiarismsearch.com/api/v3/reports/status/100500

Request

  
  /* @var $api Reports */
  require_once 'init-api.php';

  $id = 100500;
  $data = [];

  echo $api->statusAction($id, $data);

Response

  
  {
      "status": true,
      "code": 200,
      "data": {
          "id": 100500, // report id
          "auth_key": "7d765cab653f2185a83284a6",
          "remote_id": "#local-id-123",
          "user_id": 1,
          "status": 2, // report status
          "plagiat": 10.5, // plagiarism percent (deprecated)
          "plagiarism": 10.5, // plagiarism percent
          "ai_probability": 50.5, // (float or null) The percentage of likelihood that the whole text was AI generated
          "ai_average_probability": 68.44, // (float or null) The total percentage of AI generated passages in the text
          "progress": 1.0,
          "created": 1502725786, // unix timestamp of report creation
          "modified": 1504104007, // unix timestamp of report modification
          "notified": 1504104008, // unix timestamp of callback request sending
          "status_ex": "checked", // text status (deprecated)
          "status_label": "checked", // text status
          "file": "https://plagiarismsearch.com/reports/download/100500?key=54fba6bc7d765cab653f2185a83284a6" // public pdf report url
          "link": "https://plagiarismsearch.com/reports/100500?key=54fba6bc7d765cab653f2185a83284a6",  // public html report URL
          "files": [
              { // public EN pdf report URL version 3
                "url": "https://plagiarismsearch.com/r/download/100500?key=54fba6bc7d765cab653f2185a83284a6",
                "type": "application/pdf",
                "language": "en",
                "version": 3
              },
              { // public ES pdf report URL version 3
                "url": "https://plagiarismsearch.com/es/r/download/100500?key=54fba6bc7d765cab653f2185a83284a6",
                "type": "application/pdf",
                "language": "es",
                "version": 3
              },
              { // public PL pdf report URL version 3
                "url": "https://plagiarismsearch.com/pl/r/download/100500?key=54fba6bc7d765cab653f2185a83284a6",
                "type": "application/pdf",
                "language": "pl",
                "version": 3
              },
              { // public EN pdf report URL version 1 (current)
                "url": "https://plagiarismsearch.com/reports/download/100500?key=54fba6bc7d765cab653f2185a83284a6",
                "type": "application/pdf",
                "language": "en",
                "version": 1
              }
          ]
      },
      "version": "3.0.0"
  }

Error Response

  
  {
      "status": false,
      "code": 404,
      "version": "3.0.0",
      "message": "Report not found",
      "errors": [
        "Report not found"
      ]
  }


  {
      "status": false,
      "code": 401,
      "version": "3.0.0",
      "message": "Authentication failed",
      "errors": null
  }

Resource Information

Rate Limited	True
Authentication	HTTP basic
Response Format	JSON