GET
/
v1
/
evaluation
curl --request GET \
  --url https://api-staging.crazygoldfish.com/v1/evaluation \
  --header 'Authorization: Bearer <token>' \
  --header 'accept: <accept>'
{
  "status": "200",
  "message": "request successful",
  "data": [
    {
      "client_id": "<string>",
      "evaluation": [
        {
          "overview": {
            "summary": "<string>",
            "holistic_evaluation": {
              "creativity": "<string>",
              "organization": "<string>",
              "content_relevance": "<string>",
              "clarity_expression": "<string>",
              "grammar_punctuation": "<string>"
            }
          },
          "actionables": {
            "actionable_points": [
              "<string>"
            ]
          },
          "report_header": {
            "class": "<string>",
            "subject": "<string>",
            "no_of_images": "<string>",
            "student_name": "<string>",
            "date_of_evaluation": "<string>",
            "total_questions_attempted": "<string>"
          },
          "detailed_evaluation": {
            "image_assessment": [
              {
                "image": "<string>",
                "questions": [
                  {
                    "errors": [
                      {
                        "error_type": "<string>",
                        "suggestions": [
                          "<string>"
                        ]
                      }
                    ],
                    "question": 123
                  }
                ]
              }
            ],
            "total_suggestions": 123,
            "grammar_suggestions": 123,
            "spelling_suggestions": 123,
            "punctuation_suggestions": 123
          }
        }
      ],
      "evaluation_id": "<string>",
      "evaluation_type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
accept
enum<string>
default:application/json
required
Available options:
application/json

Query Parameters

​
client_id
string
required

Unique identifier assigned to the client accessing the API.

​
evaluation_format
enum<string>
default:json
required

Specifies the format of evaluation report to retrieve.

Available options:
json,
html_link
​
evaluation_type
enum<string>
default:Basic

Specifies the type of evaluation report to retrieve.

Available options:
Basic,
Overlay,
Actionable
​
student_id
string

Identifies the specific student for whom the evaluation is being requested.

​
institution_id
string

Represents the unique identifier of the institution to which the student belongs.

​
teacher_id
string

Identifies the teacher responsible for the student's evaluation.

​
parent_id
string

Specifies the unique identifier of the parent associated with the student.

​
class
string

Indicates the class or grade level of the student.

​
subject
string

Specifies the subject or topic of the handwritten notes being evaluated.

​
start_date
string
default:2024-05-17

Start date of the evaluation date range (Default is today).

​
end_date
string
default:2024-05-17

End date of the evaluation date range (Default is today).

Response

200 - application/json
Successful response
​
status
string
Example:

"200"

​
message
string
Example:

"request successful"

​
data
object[]