1. Home
  2. PlagiarismSearch.com RESTful API
  3. reports/{id}
 

reports/{id}

API version v3.0

 

View report

Resource URL

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

Parameters

Parameter Type Description Optional Default
id integer Report ID. Used in the request URL.
show_relations integer Return report relations. (Full report data).
Acceptable values are:
  • 0: Returns basic information of report (default).
  • 1: Returns all report data as tree. Paragraphs, sentences and sources with highlight text (`data.paragraphs` response field).
  • -1: Returns all report raw data (`data.paragraphs`, `data.blocks`, `data.sources` response fields).
  • -2: Returns list of sources ordered by plagiarism percent (`data.sources` response field).
  • -3: Returns html report content (`data.html` response field).
 True 0

Example

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

Request 

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

  $id = 100500;
  $data = [];

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

Response 

  
  {
      "status": true,
      "code": 200,
      "data": {
          "id": 100500, // report id
          "remote_id": "#local-id-123",
          "user_id": 1,
          "title": "Report #100500",
          "text": "Title of report",
          "length": 380, // count checked words
          "length_raw": 403, // count words
          "created": 1502725786, // unix timestamp of report creation
          "modified": 1504104007, // unix timestamp of report modification
          "notified": 0, // unix timestamp of callback request sending
          "status": 2, // report status
          "filter_chars": 1, // only latin characters
          "filter_references": 1, // exclude references
          "filter_quotes": 1, // exclude in-text citations
          "language": "en", // auto detect language of text
          "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
          "similarity": 10.5, // plagiarism percent
          "originality": 89.5, // originality percent
          "search_web": 1, // search on the web
          "search_ai": "1", // search AI content
          "search_files_api": 1, // search in storage
          "search_storage": 1, // search in storage
          "search_storage_filter": [
              "file_id": [100, 500], // exclude local file ids from storage search
              "user_id": [100, 500], // exclude local user ids from storage search
              "group_id": [100, 500], // exclude local group (course) ids from storage search
          ],
          "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