Assessments API

School assessments API

Get assessments from Insight's API using the following HTTP API.

GET https://app.insighttracking.com/api/schools/{schoolId}/assessments
          accept: application/json
          authorization: Bearer {api-key}

Authorization

You must use a school or trust API key as an authorization bearer token. Create one in Insight via Account > Admin > API Keys.

Route parameters

schoolId is the Insight school identifier (typically a 7-digit number). You can find this in the URL of any Insight school page.

URL query parameters

Use the following URL query parameters to filter the assessments. All parameters are optional.

Parameter

Type

Description

academicYear

number

Academic year, e.g. 2025 means academic year "2025-2026".

yearGroup

number

School year group, e.g. 1 means Year 1.

term

  • Entry
  • Autumn1
  • Autumn2
  • Spring1
  • Spring2
  • Summer1
  • Summer2

A school term from the fixed list of terms. Case sensitive.

name

string

Assessment name e.g. Main Assessment. Case sensitive.

subject

string

Assessment subject e.g. Reading. Case sensitive.

markSchemeId

string

Insight mark scheme ID. Case sensitive.

page

number

1-based page number. Results are limited to 100 per page.

Response

Response body JSON has the following type:

type AssessmentsResponse = {
            metadata: {
              /** The total number of assessments that match the query. */
              totalResults: number;
          
              /** The requested page number of results. */
              page: number;
          
              /** The total number of pages. */
              totalPages: number;
            };
          
            assessments: Array;
          }
          
          type Assessment = {
            /** Unique identifier for the assessment */
            id: string;
          
            /** Pupil identifiers */
            pupil: {
              /** Insight's internal pupil ID */
              id: string;
          
              /** The DfE Unique Pupil Number (Optional) */
              upn: string;
          
              /** MIS ID (optional) */
              misId: string;
            };
          
            /** The commencing year of the academic year of the assessment.
                For example, 2025 means academic year "2025-2026". */
            academicYear: number;
          
            /** The school year group when the assessment was made.
                0 = Reception; 1 = Year 1; 2 = Year 2; etc. */
            yearGroup: number;
          
            /** The half-term of the academic year. */
            term: "Entry" | "Autumn1" | "Autumn2" | "Spring1" | "Spring2" | "Summer1" | "Summer2";
          
            /** The assessment name e.g. "Main Assessment" */
            name: string;
          
            /** The assessment subject e.g. "Reading" */
            subject: string;
          
            /** The assessment mark/result/grade. */
            mark: {
              /** Human readable description of the mark. */
              text: string;
          
              /** Insight's internal mark scheme ID that determines the type of this mark. */
              markSchemeId: string;
          
              /** The mark's JSON value. The value type varies by mark type. */
              value: unknown;
            };
          };
          


How did we do?


Powered by HelpDocs (opens in a new tab)