v1

latestOpenAPI 3.0.0Apache 2.02026-08-0610023171.4 KB
Individuals

Get report by report ID

Return a plagiarism report directly by report ID, including report metadata and parsed report data when available. Reports for deleted texts are treated as not found.

get/api/v1/report/{reportId}

Path parameters

reportIdinteger required

Numeric report ID.

Response

The request succeeded and returned report metadata and parsed report data. Some successful responses include a warning and report_data: null when parsed data is unavailable.

successboolean

Present on text-report responses; can be false when the text is not checked or parsed data is missing.

warningstring

Warning message included when report data cannot be returned.

Example response

{
  "success": true,
  "data": {
    "report": {
      "id": 15,
      "created_at": 1513617036000,
      "source_count": 3,
      "text_id": 55,
      "group_id": 100
    },
    "report_data": {
      "version": "1.1",
      "length": 637,
      "matched_length": 182,
      "matched_percent": 28.57,
      "nodes": [
        {
          "enabled": true,
          "end": 19,
          "text": "lorem ipsum dolor",
          "sources": [
            1
          ],
          "sources_improved": [
            1
          ],
          "references": [
            1
          ],
          "headers": [
            1
          ],
          "quotes": [
            1
          ],
          "destinations_clusters": [
            1
          ]
        }
      ],
      "indexes": [
        {
          "type": "external"
        }
      ],
      "references": [
        {
          "length": 35
        }
      ],
      "header": [
        {
          "length": 35
        }
      ],
      "quotes": [
        {
          "length": 35
        }
      ],
      "sources": [
        {
          "dst_pos_success": true,
          "content_type": "text/plain",
          "source": "https://en.wikipedia.org/wiki/Open_source",
          "length": 255,
          "percent": 40.03,
          "plagiarism_length": 182,
          "plagiarism_percent": 28.57
        }
      ],
      "created_at": "2017-05-12 05:10:57",
      "sources_count": 5,
      "external_queries": 12,
      "destinations_clusters": [
        {
          "offsets": [
            {
              "start": 20,
              "end": 34,
              "cos": 1
            }
          ]
        }
      ],
      "ignored_ranges": [
        {
          "id": 123,
          "start": 42,
          "end": 87,
          "filename": "assignment-template.docx",
          "ignore_assignment_template_id": 55
        }
      ]
    }
  },
  "warning": "Report data is missed or its parsing failed"
}