List AttemptInsights

GET

/attempt-insights

Request

Query Params

attempt

string

required

insightTypes

array[string]

optional

Allowed values:

microOutcomeCorrectmicroOutcomeIncorrectmicroOutcomePartialminiIndividualTimeSpentminiIndividualAttemptImprovementminiIndividualStudentVsCohortAverageminiIndividualPercentileminiIndividualAttemptGrade

cohort

enum<string>

optional

Used to override the default analytics cohort for the attempt.

Allowed values:

examquizsourceQuiz

viewerType

enum<string>

optional

Used to override the result settings for an attempt

Allowed values:

studentadmin

Default:

student

Example:

student

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (AttemptInsight) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AttemptInsight

Example:

AttemptInsight

attributes

object

optional

relationships

object

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "AttemptInsight",
            "attributes": {
                "insightType": "microOutcomeCorrect",
                "value": "string",
                "label": "string",
                "description": "string",
                "highlightType": "user",
                "secondaryValue": "string",
                "secondaryVariant": "positive",
                "secondaryTooltip": "string"
            },
            "relationships": {
                "attempt": {
                    "data": {
                        "id": "FID001",
                        "type": "Attempt"
                    }
                }
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-08 10:51:21

List AttemptCharts

Create AttemptLock