Assignment Grader

Generate educator report for an assignment

GET · Assignment Grader

GET/api/v1/assignment-grader/educator-report/{assignmentId}

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/assignment-grader/educator-report/%3CassignmentId%3E' \
  --header 'x-api-key: <API_KEY>'

Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.

Replace https://api.example.com with the API server URL.

Parameters

assignmentIdpath · string · required

Assignment ID to generate report for

Responses

200Educator report generated successfully

{
  "type": "object",
  "properties": {
    "assignmentId": {
      "type": "string",
      "description": "Assignment ID"
    },
    "title": {
      "type": "string",
      "description": "Assignment title"
    },
    "totalSubmissions": {
      "type": "number",
      "description": "Total number of submissions"
    },
    "statistics": {
      "description": "Grade statistics",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "averageGrade": {
              "type": "string",
              "description": "Average grade"
            },
            "minGrade": {
              "type": "string",
              "description": "Minimum grade"
            },
            "maxGrade": {
              "type": "string",
              "description": "Maximum grade"
            },
            "standardDeviation": {
              "type": "string",
              "description": "Standard deviation"
            }
          },
          "required": [
            "averageGrade",
            "minGrade",
            "maxGrade",
            "standardDeviation"
          ]
        }
      ]
    },
    "gradeDistribution": {
      "description": "Grade distribution",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "A": {
              "type": "number",
              "description": "Number of A grades (90-100)"
            },
            "B": {
              "type": "number",
              "description": "Number of B grades (80-89)"
            },
            "C": {
              "type": "number",
              "description": "Number of C grades (70-79)"
            },
            "D": {
              "type": "number",
              "description": "Number of D grades (60-69)"
            },
            "F": {
              "type": "number",
              "description": "Number of F grades (0-59)"
            }
          },
          "required": [
            "A",
            "B",
            "C",
            "D",
            "F"
          ]
        }
      ]
    },
    "criteriaAnalysis": {
      "description": "Analysis per criterion",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Criterion title"
          },
          "avgScore": {
            "type": "number",
            "description": "Average score for this criterion"
          },
          "maxPossible": {
            "type": "number",
            "description": "Maximum possible points"
          },
          "submissionCount": {
            "type": "number",
            "description": "Number of submissions graded"
          }
        },
        "required": [
          "title",
          "avgScore",
          "maxPossible",
          "submissionCount"
        ]
      }
    },
    "strengths": {
      "description": "Top performing criteria",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Criterion title"
          },
          "avgScore": {
            "type": "string",
            "description": "Average score"
          },
          "maxPossible": {
            "type": "number",
            "description": "Maximum possible points"
          },
          "performanceRatio": {
            "type": "string",
            "description": "Performance ratio as percentage"
          }
        },
        "required": [
          "title",
          "avgScore",
          "maxPossible",
          "performanceRatio"
        ]
      }
    },
    "weaknesses": {
      "description": "Criteria needing improvement",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Criterion title"
          },
          "avgScore": {
            "type": "string",
            "description": "Average score"
          },
          "maxPossible": {
            "type": "number",
            "description": "Maximum possible points"
          },
          "performanceRatio": {
            "type": "string",
            "description": "Performance ratio as percentage"
          }
        },
        "required": [
          "title",
          "avgScore",
          "maxPossible",
          "performanceRatio"
        ]
      }
    },
    "submissions": {
      "description": "List of all submissions",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Submission ID"
          },
          "studentIdentifier": {
            "type": "string",
            "description": "Student identifier"
          },
          "grade": {
            "type": "number",
            "description": "Grade percentage"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "description": "Submission date"
          }
        },
        "required": [
          "id",
          "studentIdentifier",
          "grade",
          "createdAt"
        ]
      }
    }
  },
  "required": [
    "assignmentId",
    "title",
    "totalSubmissions",
    "statistics",
    "gradeDistribution",
    "criteriaAnalysis",
    "strengths",
    "weaknesses",
    "submissions"
  ]
}