Get struggling quiz-mastery students

curl --request GET \
  --url https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "minimumAttempts": 123,
  "summary": {
    "struggling": 1,
    "masteredAfterStruggle": 1
  },
  "pageInfo": {
    "limit": 50,
    "total": 1,
    "nextCursor": "<string>"
  },
  "rows": [
    {
      "studentId": "<string>",
      "studentName": "<string>",
      "courseId": "<string>",
      "courseTitle": "<string>",
      "lessonId": "<string>",
      "lessonTitle": "<string>",
      "threshold": 50,
      "attemptCount": 123,
      "latestAccuracy": 50,
      "status": "struggling",
      "masteredOnAttempt": 123,
      "lastAttemptAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unauthorisedrequest"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "forbidden"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unknownobject"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "server_busy"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "internal_server_error"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

Lesson Mastery

Get struggling quiz-mastery students

Returns staff-facing rows for students who reached the configured attempt threshold on a gated quiz.

The effective staff viewer is authorized against the acting user’s verified JWT. Administrators receive tenant-wide results; teachers receive only students who share an active class with them. Results are paginated by student-quiz cohort so all attempts used for one classification remain on the same page. Continue with the opaque nextCursor value when present.

Client-credential callers must forward the signed Cognito user ID token in X-ID-Token. This route authorizes its effective-viewer parameters directly because its raw cohort CTE cannot consume the platform visibility filter used by standard ORM-backed cross-user reads.

Students who have not yet met the quiz threshold are categorized as struggling. Students whose first passing attempt was at or after the configured minimum are categorized as mastered_after_struggle. Passing before the minimum excludes the student from this view.

GET

powerpath

getQuizMasteryDashboard

Get struggling quiz-mastery students

curl --request GET \
  --url https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.alpha-1edtech.ai/powerpath/getQuizMasteryDashboard")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "minimumAttempts": 123,
  "summary": {
    "struggling": 1,
    "masteredAfterStruggle": 1
  },
  "pageInfo": {
    "limit": 50,
    "total": 1,
    "nextCursor": "<string>"
  },
  "rows": [
    {
      "studentId": "<string>",
      "studentName": "<string>",
      "courseId": "<string>",
      "courseTitle": "<string>",
      "lessonId": "<string>",
      "lessonTitle": "<string>",
      "threshold": 50,
      "attemptCount": 123,
      "latestAccuracy": 50,
      "status": "struggling",
      "masteredOnAttempt": 123,
      "lastAttemptAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unauthorisedrequest"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "forbidden"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unknownobject"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "server_busy"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "internal_server_error"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

minimumAttempts

integer

default:4

First attempt number included in the struggling cohort

course

string

Optional course sourcedId filter

status

enum<string>

Optional mastery cohort filter applied before pagination

Available options:

struggling,

mastered_after_struggle

limit

integer

default:50

Maximum number of student-quiz cohorts returned per page

Required range: 1 <= x <= 100

cursor

string

Opaque cursor returned by the previous page

Minimum string length: 1

effectiveViewerId

string

Server-resolved effective viewer sourcedId. The authenticated user must be authorized to assume this viewer.

Minimum string length: 1

effectiveRole

enum<string>

Server-resolved active role for the effective viewer. Must be supplied with effectiveViewerId.

Available options:

administrator,

teacher

Response

Success

minimumAttempts

integer

required

summary

object

required

Show child attributes

pageInfo

object

required

Show child attributes

rows

object[]

required

Show child attributes

⌘I