List AttemptCharts

GET

/attempt-charts

Request

Query Params

attempt

string

required

chartTypes

array[string]

optional

Allowed values:

individualStudentVsCohortBellCurvesubjectBreakdowntopicBreakdownsubtopicBreakdownskillBreakdowndifficultyBreakdownsubjectProgresstopicProgresssubtopicProgressoverallProgress

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

tagFilterByFacet

object

optional

Used to filter the chart data by facet. Each property corresponds to a facet type, and the values are arrays of tag IDs to filter by.

subject

array[string]

optional

topic

array[string]

optional

subtopic

array[string]

optional

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 (AttemptChart) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AttemptChart

Example:

AttemptChart

attributes

object

optional

relationships

object

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "AttemptChart",
            "attributes": {
                "chartType": "individualStudentVsCohortBellCurve",
                "series": [
                    {
                        "label": "string",
                        "dataset": [
                            {
                                "category": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "xAxes": {
                    "type": "category",
                    "title": "string",
                    "min": 0,
                    "max": 0
                },
                "yAxes": {
                    "type": "category",
                    "title": "string",
                    "min": 0,
                    "max": 0
                },
                "markers": [
                    {
                        "axis": "string",
                        "axisValue": "string",
                        "label": "string"
                    }
                ],
                "ranges": [
                    {
                        "startCategory": "string",
                        "endCategory": "string",
                        "type": "standardDeviation",
                        "tooltipText": "string"
                    }
                ],
                "error": "string",
                "description": "string",
                "dataAnnotation": "string",
                "title": "string"
            },
            "relationships": {
                "attempt": {
                    "data": {
                        "id": "FID001",
                        "type": "Attempt"
                    }
                }
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

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

List Assignments

List AttemptInsights