Chart Generation – Interim Data

POST /student-growth-interim: Generate a growth chart based on student interim assessment data.

Interim: This endpoint accepts interim Lexile and/or Quantile measures derived from approved assessment sources. For each submitted measure, the following information is required: the date the measure was obtained, the student’s grade at the time of testing, and the school year start date for that grade. The Growth Planner API uses this data to project a student’s growth in reading and/or math across configurable grade ranges, which may begin as early as kindergarten and extend through grade 12, in relation to defined readiness targets. Results are returned as data output, with an optional MetaMetrics graph that can be configured to meet partner requirements.

Base URL: https://growth-planner-api.lexile.com/student-growth-interim

Given historical student performance (measurements, dates) on interim assessments, this API will generate a graph of projected growth. No PII is required by the API, and no data is saved.

The graph plots the student’s interim measure(s) and predicts growth through 12th grade. The graph is WCAG 2.1 AA compliant, and all information required for the generation of informative alt-text is in the response data. Clients should use this data to write their own alt-text.

Parameters

POST /authToken Retrieve an Auth Token for use with protected endpoints.

application/json

Sample request body for the Lexile scale.

{
          "scale": "lexile",
          "language": "english",
          "measures": [
          {
          "testDate": { "month": 3, "year": 2021 },
          "schoolYearStart": { "month": 8, "year": 2020 },
          "grade": 4,
          "measure": 815
          }
          ],
          "additionalOptions": [
          "recommendedGrowthPath",
          "universityReadinessRange",
          "communityCollegeReadinessRange",
          "workplaceReadinessRange"
          ]
          }

Sample request body for the Lexile scale with custom target ranges.

{
          "scale": "lexile",
          "language": "english",
          "measures": [
          {
          "testDate": { "month": 3, "year": 2021 },
          "schoolYearStart": { "month": 8, "year": 2020 },
          "grade": 4,
          "measure": 815
          }
          ],
          "targetRanges": {
          "harderRange": {
          "max": { "value": 1500 },
          "min": { "value": 1300 },
          "label": "More Difficult Target"
          },
          "easierRange": {
          "max": { "value": 1300 },
          "min": { "value": 1100 },
          "label": "Less Difficult Target"
          }
          }
          }

Sample request body for the Quantile scale.

{
          "scale": "quantile",
          "language": "english",
          "measures": [
          {
          "testDate": { "month": 3, "year": 2021 },
          "schoolYearStart": { "month": 8, "year": 2020 },
          "grade": 4,
          "measure": 815
          }
          ],
          "additionalOptions": [
          "recommendedGrowthPath",
          "advancedCollegeAndCareerReadinessRange",
          "fundamentalCollegeAndCareerReadinessRange",
          "limitedCollegeAndCareerReadinessRange"
          ]
          }

Responses


Code	Description
`200`	Success Media Type: application/json
`400`	Validation error response
`401`	Client error response
`500`	Server error response