Canvas GraphQL API Missing Data

maxrosoff

How do I retrieve the submission history for an assignments with GraphQL? In the REST API you need to manually specify to include submission_history. This is one of many fields that is seemingly inaccessible, is there any plans to bring the GraphQL API to feature parity?

/api/v1/courses/:courseId/students/submissions?include[]=submission_history

Thanks!

James

@maxrosoff 

Not all information available through the REST API is available through GraphQL and vice versa. There are four main sources of information I use and the same is true for all of them: REST API, GraphQL, Canvas Data 2, and Live Events. Each of them has a target in mind. GraphQL was designed to be quick lookups and while some functionality was ported from the REST API, not all of it is there. There was a comment at one point that if you were missing something, to request it, but there's no guarantee it will get there.

That warning out of the way, you can use the submissionHistoriesConnection under a Submissions property to get the Submissions History. Here's an example query that gets all submissions that were made for one of my classes since today (obviously today becomes outdated very quickly).

query submissionHistoryCourse {
  course(id: "4014893") {
    submissionsConnection(filter: {gradedSince: "2024-09-27T00:00:00Z"}) {
      nodes {
        _id
        assignmentId
        submissionHistoriesConnection(filter: {includeCurrentSubmission: true}) {
          nodes {
            attempt
            score
          }
        }
      }
    }
  }
}

 

You can also get all of the submissions for a single assignment with more flexibility in the filtering.

query submissionHistoryAssignment {
  assignment(id: "45956245") {
    submissionsConnection(filter: {enrollmentTypes: StudentEnrollment}) {
      nodes {
        _id
        submissionHistoriesConnection {
          nodes {
            attempt
            score
          }
        }
      }
    }
  }
}

 

Likewise, you can get the submission history for an individual submission.

A potential issue may be what you want from the submission histories. Not all information from the REST API is there (hence my warning at the start). With the submission_history from the REST API, I can get the answers given for Classic Quizzes. That is not available for the REST API. However, scores, rubrics, and a lot of other stuff is there.