--- title: "Get report by report ID" method: GET path: "/api/v1/report/{reportId}" tags: ["Individuals"] --- # Get report by report ID `GET /api/v1/report/{reportId}` ## Request - Base URL: `https://plagiarismcheck.org` - URL: `https://plagiarismcheck.org/api/v1/report/{reportId}` - Auth: API key in header `X-API-TOKEN` 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. ## Path parameters - `reportId` integer, required ## Response `200` 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. - object - `success` boolean: Present on text-report responses; can be `false` when the text is not checked or parsed data is missing. - `data` object - `report` Report - `id` integer, required: Numeric report ID. - `created_at` integer, required: Unix timestamp in milliseconds. - `source_count` integer, required: Number of matched sources found in the report. - `percent` union, required: Similarity percentage for the checked text. - number - string - `text_id` integer, required: Numeric ID of the text check associated with this report. - `group_id` integer, nullable: Group associated with the text check, or `null`. - `report_data` ReportData: Parsed plagiarism report data, including matched text fragments, sources, and similarity metrics. - `version` string, required: Parsed report format version. - `length` integer, required: Total length of the checked text in characters. - `matched_length` integer, required: Total number of matched characters across all sources. - `matched_percent` number, required: Percentage of the submitted text matched to sources. - `nodes` object[], required: Text fragments with match metadata and references to sources. - `enabled` boolean: Whether this fragment is currently included in the similarity calculation. - `start` integer: Start character offset of the fragment. - `end` integer: End character offset of the fragment. - `text` string: Text fragment content. - `sources` integer[] - `sources_improved` integer[] - `references` integer[] - `headers` integer[] - `quotes` integer[] - `destinations_clusters` integer[] - `indexes` object[], required: Search indexes used to produce report matches. - `id` integer: Search index identifier. This also corresponds to the index position in the report `indexes` array. - `type` string: Search index type, for example external or checked. - `references` object[], required: Reference fragments detected in the submitted text. - `id` integer: Reference fragment ID. - `length` integer: Reference fragment length in characters. - `header` object[], required: Header fragments detected in the submitted text. - `id` integer: Header fragment ID. - `length` integer: Header fragment length in characters. - `quotes` object[], required: Quoted fragments detected in the submitted text. - `id` integer: Quote fragment ID. - `length` integer: Quote fragment length in characters. - `sources` object[], required: Matched external or internal sources. - `dst_pos_success` boolean: Whether destination positions were resolved successfully for this source. - `content_type` string: MIME content type returned for the matched source when available. - `index` integer: Index ID that produced this source match. - `source` string: URL or source identifier for the matched source. - `length` integer: Length of the matched source text in characters. - `percent` number: Percentage contribution of this source to the overall similarity score. - `link` object: Human-readable link metadata for the source. - `name` string: Display name for the source domain or document. - `url` string[]: URLs associated with this source. - `tf_idf` boolean: Whether TF-IDF matching was used for this source. - `plagiarism_length` integer: Number of matched characters attributed to this source. - `plagiarism_percent` number: Percentage of submitted text matched to this source. - `created_at` string, required: Parsed report creation date. - `sources_count` integer, required: Total number of matched sources in the report. - `external_queries` integer, required: Number of external search queries used for the report. - `destinations_clusters` object[], required: Clusters linking matched source destinations to text offsets. - `source` integer: Source index for this destination cluster. - `id` integer: Destination cluster ID. - `offsets` object[]: Matched offsets for this destination cluster. - `start` integer: Start character offset. - `end` integer: End character offset. - `cos` number: Cosine similarity score for the offset. - `ignored_ranges` TextIgnoredRange[]: Character ranges excluded from the similarity calculation because they match assignment ignore templates. This field is optional and is returned only when ignored ranges exist. - `id` integer, nullable: Internal ignored range identifier. - `start` integer: Start character offset of the ignored range. - `end` integer: End character offset of the ignored range. - `filename` string: Name of the ignore assignment template file that produced this range. - `ignore_assignment_template_id` integer, nullable: Identifier of the ignore assignment template that produced this range. - `warning` string: Warning message included when report data cannot be returned. ## Other responses - `403`: Authentication or authorization failed because the token is missing, invalid, blocked, or not allowed to access the resource. - `404`: The requested resource was not found. --- [API](https://skmtc.dev/plagiarismcheck/apis/plagiarismcheck-org-api.md) - [All operations](https://skmtc.dev/plagiarismcheck/apis/plagiarismcheck-org-api/llms.txt) - [OpenAPI document](https://skmtc.dev/plagiarismcheck/apis/plagiarismcheck-org-api/revisions/2c81c29267dc?raw)