Code Plagiarism & Web Similarity API

Getting an overview of results

Get the submissions and their highest similarity score, as well as all the comparisons made to other submissions. Bardata will return the highest score that was matched for the submission. Note that the results overview only displays data from peer check results. These are the similarity results for local comparisons to the submissions uploaded in your check.

Note that you may also call the endpoint .../check/overviewCSV to retrieve a CSV format

When sending the request, we will need to send the check_id:

				curl -X POST \
  'https://codequiry.com/api/v1/check/overview?check_id=YOUR_CHECK_ID' \
    -H 'apikey:  YOUR_API_KEY_HERE '
				

					

						cURL Command
					
				
			

Sample Response (JSON Array)

				{
    "overviewURL": "https://dashboard.codequiry.com/course/10970/assignment/2821/overview",
    "submissions": [
        {
            "id": 14587,
            "filename": "MiniFactorial-T3-ForWhile",
            "status_id": 4,
            "created_at": "2019-05-31 15:55:23",
            "updated_at": "2019-05-31 16:39:43",
            "result1": "0.00",
            "result2": "0.00",
            "result3": "0.00",
            "total_result": "48.65",
            "submissionresults": [
                {
                    "id": 463587,
                    "submission_id": 14587,
                    "submission_id_compared": 14588,
                    "score": "0.00",
                    "created_at": null,
                    "updated_at": null
                },
                {
                    "id": 463588,
                    "submission_id": 14587,
                    "submission_id_compared": 14589,
                    "score": "48.65",
                    "created_at": null,
                    "updated_at": null
                }
            ]
        },
        {
            "id": 14588,
            "filename": "MiniFactorial-T3-JumpLabel",
            "status_id": 4,
            "created_at": "2019-05-31 15:55:23",
            "updated_at": "2019-05-31 16:39:43",
            "result1": "0.00",
            "result2": "0.00",
            "result3": "0.00",
            "total_result": "0.00",
            "submissionresults": [
                {
                    "id": 463589,
                    "submission_id": 14588,
                    "submission_id_compared": 14589,
                    "score": "0.00",
                    "created_at": null,
                    "updated_at": null
                }
            ]
        },
        {
            "id": 14589,
            "filename": "MiniFactorial-T3-VariableBigInt",
            "status_id": 4,
            "created_at": "2019-05-31 15:55:23",
            "updated_at": "2019-05-31 16:39:43",
            "result1": "0.00",
            "result2": "0.00",
            "result3": "0.00",
            "total_result": "48.65",
            "submissionresults": []
        }
    ],
    "bardata": [
        {
            "submission": "MiniFactorial-T3-ForWhile",
            "score": "48.65"
        },
        {
            "submission": "MiniFactorial-T3-VariableBigInt",
            "score": "48.65"
        }
    ]
}
				

					

						JSON Array
					
				
			

Note that if the total_result field is -0.1, this means that there was an "Error parsing files" for the submission. This could mean many things, maybe the zip file was corrupted, no files were parsed for the programming language selected, or the encoding of the files were incompatible.

Error Format Response (422 error)

                {
    "error": "The check has not been completed."
}
                

                    

                        JSON Array
                    
                
            

What's next

For optimal understanding of API usage, we recommend following this guide.

• 9. Detailed Results