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

# Get results overview

`POST /check/overview`

## Request

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

Per-submission similarity scores and bar-chart data. The check must be completed (status_id 4) or you get 409.

## Request body

- object
  - `check_id` integer, required

## Response `200`

Overview

- object
  - `overviewURL` string
  - `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
  - `bardata` object[]
    - `submission` string
    - `score` number

## 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)