Attempts

info

Admin APIs require authorization token with admin privileges. You check the following link to generate authorization token. You need to provide admin username and password to generate token with admin privileges

Authentication

All operations related to user attempt can be done using the following end points.

List Attempts

This endpoint returns all attempts. Attempts can be filtered based on user or exams

Get https:// institute_url /api/v2.5/admin/attempts
Attempts List API

This endpoint returns all attempts.

Parameters

Query

ordering	string	This will sort the results date Oldest started attempts will be displayed first -date - Recently started attempts will be displayed first correctanswers_count - Attempts with least correct answers will be displayed first -correct answers_count - Attempts with more correct answers will be displayed first incorrectLanswers_count - Attempts with least incorrect answers will be displayed first -incorrectanswers_count Attempts with more incorrect answerss will be displayed first unanswered_count - Attempts with least unanswered answers will be displayed first -unanswered_count - Attempts with more unanswered will be displayed first
state	number	This will filter attempts based on the following states 0-Running Attempts 1- Completed Attempts 3-Not started
date_1	string	This will display all attempts which started before this date
date_0	string	This will display all attempts which started after this date
Users	integer	To get attempts of an user. Value should be user id Ex: users=1
exams	integer	To filter attempts by exam. Value should be exam id exams Ex: exams=3

Responses

200

{
"count":1,
"next":"https://sandbox.testpress.in/api/v2.5/admin/attempts/?page=2",
"previous":null,
"per_page":200,
"results":[
{
id: 68701,
date: "2021-03-16T03:59:21.860924Z",
exam_id: 133,
user_id: 143,
email: null,
name: null,
phone: null,
correct_answers_count: 220,
incorrect_answers_count: 20,
unanswered_count: 200,
score: "90.00",
percentage: 0,
time_taken: "0:00:00",
remaining_time: null,
result: "Not taken",
state: "Completed",
last_started_time: null,
last_answer_updated_time: null,
speed: 0,
exam_url: "https://sandbox.testpress.in/api/v2.5/admin/exams/133/",
user_url: "https://sandbox.testpress.in/api/v2.5/admin/users/133/"
}]
}

Examples

• /api/v2.5/admin/attempts/?exams=5 - This will display attempt of exam with id 5
• /api/v2.5/admin/attempts/?users=1&exams=2 - This will display attempts of exam whose id is 2 for the user id 1
• /api/v2.5/admin/attempts/?date_0=2020-01-11&date_1=2021-02-02&ordering=date - This will display attempts that are attempted between 11/1/2020 and 2/2/2021. Oldest attempted exams will be displayed first

Get A Single Attempt

This endpoint retrieves a single attempt.

HTTP Request

GET /api/v2.5/admin/attempts/<id>/

URL Parameters

Parameter	Description
id	The unique id of the attempt to retrieve

cURL

curl --request GET \
  --url http://demo.testpress.in/api/v2.5/admin/attempts/125894/ \
  --header 'authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RwcmVzcyIsInVzZXJfaWQiOjE3LCJlbWFpbCI6InRlc3RwcmVzcy5pbkBnbWFpbC5jb20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lgXakk_syV-vSw' \
  --header 'cache-control: no-cache'

Ruby

require 'uri'
require 'net/http'

url = URI("http://demo.testpress.in/api/v2.5/admin/attempts/125894/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["authorization"] = 'JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RwcmVzcyIsInVzZXJfaWQiOjE3LCJlbWFpbCI6InRlc3RwcmVzcy5pbkBnbWFpbC5jb20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lgXakk_syV-vSw'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

Python

import requests

url = "http://demo.testpress.in/api/v2.5/admin/attempts/125894/"

headers = {
    'authorization': "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3RwcmVzcyIsInVzZXJfaWQiOjE3LCJlbWFpbCI6InRlc3RwcmVzcy5pbkBnbWFpbC5jb20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lgXakk_syV-vSw",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Response

{
    "id": 1,
    "date": "2023-01-23T11:35:37.930389+05:30",
    "exam_id": 2,
    "user_id": 2,
    "email": "hariharan@testpress.in",
    "name": null,
    "phone": null,
    "correct_answers_count": 0,
    "incorrect_answers_count": 1,
    "unanswered_count": 79,
    "score": "0.00",
    "percentage": 0,
    "percentile": 100.0,
    "time_taken": "2:47:53.076906",
    "remaining_time": "0:00:00",
    "result": "Fail",
    "state": "Completed",
    "last_started_time": "2023-04-02T15:27:46.453786+05:30",
    "last_answer_updated_time": "2023-04-02T15:27:59.639308+05:30",
    "speed": 0,
    "exam_url": "http://demo.tespress.in/api/v2.5/admin/exams/2/",
    "user_url": "http://demo.tespress.in/api/v2.5/admin/users/2/",
    "username": "admin",
    "sections": [
        {
            "id": 1,
            "order": 0,
            "section_id": 2,
            "time_taken": "0:00:00",
            "correct_answers_count": 0,
            "incorrect_answers_count": 0,
            "unanswered_count": 20,
            "score": "0.00"
        },
        {
            "id": 2,
            "order": 1,
            "section_id": 3,
            "time_taken": "0:00:00",
            "correct_answers_count": 0,
            "incorrect_answers_count": 1,
            "unanswered_count": 20,
            "score": "0.00"
        },
        {
            "id": 3,
            "order": 2,
            "section_id": 4,
            "time_taken": "0:00:00",
            "correct_answers_count": 0,
            "incorrect_answers_count": 0,
            "unanswered_count": 20,
            "score": "0.00"
        },
        {
            "id": 4,
            "order": 3,
            "section_id": 5,
            "time_taken": "0:00:00",
            "correct_answers_count": 0,
            "incorrect_answers_count": 0,
            "unanswered_count": 19,
            "score": "0.00"
        }
    ],
    "subject_stats": [
        {
            "subject_id": 1,
            "subject_name": "Geography",
            "total_count": 64,
            "correct_answers_count": 0,
            "unanswered_count": 63,
            "incorrect_answers_count": 1,
            "parent_subject_id": null,
            "is_leaf": true,
            "score": "0.00",
            "partial_correct_answers_count": 0
        },
        {
            "subject_id": 2,
            "subject_name": "Current affairs",
            "total_count": 12,
            "correct_answers_count": 0,
            "unanswered_count": 12,
            "incorrect_answers_count": 0,
            "parent_subject_id": null,
            "is_leaf": true,
            "score": "0.00",
            "partial_correct_answers_count": 0
        },
        {
            "subject_id": null,
            "subject_name": "History",
            "total_count": 4,
            "correct_answers_count": 0,
            "unanswered_count": 4,
            "incorrect_answers_count": 0,
            "parent_subject_id": null,
            "is_leaf": true,
            "score": "0.00",
            "partial_correct_answers_count": 0
        }
    ],
    "difficulty_level_stats": {
        "easy": {
            "correct_answers_count": 0,
            "incorrect_answers_count": 1,
            "partial_correct_answers_count": 0,
            "unanswered_count": 69,
            "total_count": 70
        },
         "medium": {
            "correct_answers_count": 0,
            "incorrect_answers_count": 5,
            "partial_correct_answers_count": 0,
            "unanswered_count": 5,
            "total_count": 10
        }
    },
    "institute_attempt_id": 100101
}