---
title: "Get detailed results"
method: POST
path: "/check/results"
tags: ["Results"]
---

# Get detailed results

`POST /check/results`

## Request

- Base URL: `https://codequiry.com/api/v1`
- URL: `https://codequiry.com/api/v1/check/results`
- Auth: API key in header `apikey`

Full match detail for one submission, including peer, web/external, and AI matches.

## Request body

- object
  - `check_id` integer, required
  - `submission_id` integer, required

## Response `200`

Detailed results

- object
  - `submission` Submission
    - `id` integer
    - `assignment_id` integer
    - `filename` string
    - `status_id` integer
    - `total_result` number
    - `result_web` number
    - `submissionresults` object[]: One row per peer submission this one scored against, highest score first.
      - `id` integer
      - `submission_id` integer
      - `submission_id_compared` integer
      - `score` number: Similarity percentage against that submission.
      - `file` string
      - `file_matched` string
      - `lines` integer: Lines covered by the matched region.
      - `longest` integer: Longest single matched run, in lines.
      - `location` string: Empty for peer matches; the path within the source for web matches.
      - `source` string
  - `avg` number
  - `max` number
  - `min` number
  - `other_matches` Match[]
    - `id` integer
    - `submission_id` integer
    - `submission_id_matched` integer
    - `similarity` number
    - `matched_similarity` number
    - `file` string
    - `file_matched` string
    - `line_start` integer
    - `line_end` integer
    - `line_matched_start` integer
    - `line_matched_end` integer
    - `tokens` integer
    - `match_type` integer
    - `location` string
    - `source` string
  - `related_submissions` Submission[]
    - `id` integer
    - `assignment_id` integer
    - `filename` string
    - `status_id` integer
    - `total_result` number
    - `result_web` number
    - `submissionresults` object[]: One row per peer submission this one scored against, highest score first.
      - `id` integer
      - `submission_id` integer
      - `submission_id_compared` integer
      - `score` number: Similarity percentage against that submission.
      - `file` string
      - `file_matched` string
      - `lines` integer: Lines covered by the matched region.
      - `longest` integer: Longest single matched run, in lines.
      - `location` string: Empty for peer matches; the path within the source for web matches.
      - `source` string
  - `related_files` object[]
    - `id` integer
    - `submission_id` integer
    - `filedir` string: Path of the file inside the uploaded archive.
    - `content` string: The stored source text.
    - `language_id` integer
    - `updated_at` string

## Other responses

- `401`: Missing or invalid API key. The API key is checked before any endpoint logic runs, so this is returned for every operation.
- `402`: The account is suspended for an unpaid invoice. Every endpoint returns this until the invoice is paid from the billing dashboard; it is not retryable and the request was not performed.
- `409`: Check is in a state that does not allow this operation (e.g. still processing, or not yet completed).
- `422`: Request validation failed.
- `429`: Rate limit exceeded: more than 60 requests in one minute from this IP. Retry after the number of seconds in the Retry-After header. Successful responses carry X-RateLimit-Limit and X-RateLimit-Remaining too, so you can pace a client without waiting to be refused.

---

[API](https://skmtc.dev/codequiry/apis/codequiry-api.md) · [All operations](https://skmtc.dev/codequiry/apis/codequiry-api/llms.txt) · [OpenAPI document](https://skmtc.dev/codequiry/apis/codequiry-api/revisions/6297e91d9665?raw)