Skip to main content
GET
/
api
/
v1
/
assignment-grader
/
educator-report
/
{assignmentId}
Generate educator report for an assignment
const url = 'https://studyfetchapi.com/api/v1/assignment-grader/educator-report/{assignmentId}';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "assignmentId": "<string>",
  "title": "<string>",
  "totalSubmissions": 123,
  "statistics": {
    "averageGrade": "<string>",
    "minGrade": "<string>",
    "maxGrade": "<string>",
    "standardDeviation": "<string>"
  },
  "gradeDistribution": {
    "A": 123,
    "B": 123,
    "C": 123,
    "D": 123,
    "F": 123
  },
  "criteriaAnalysis": [
    {
      "title": "<string>",
      "avgScore": 123,
      "maxPossible": 123,
      "submissionCount": 123
    }
  ],
  "strengths": [
    {
      "title": "<string>",
      "avgScore": "<string>",
      "maxPossible": 123,
      "performanceRatio": "<string>"
    }
  ],
  "weaknesses": [
    {
      "title": "<string>",
      "avgScore": "<string>",
      "maxPossible": 123,
      "performanceRatio": "<string>"
    }
  ],
  "submissions": [
    {
      "id": "<string>",
      "studentIdentifier": "<string>",
      "grade": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

assignmentId
string
required

Assignment ID to generate report for

Response

200 - application/json

Educator report generated successfully

assignmentId
string
required

Assignment ID

title
string
required

Assignment title

totalSubmissions
number
required

Total number of submissions

statistics
object
required

Grade statistics

gradeDistribution
object
required

Grade distribution

criteriaAnalysis
object[]
required

Analysis per criterion

strengths
object[]
required

Top performing criteria

weaknesses
object[]
required

Criteria needing improvement

submissions
object[]
required

List of all submissions