List CustomInsights

GET

/custom-insights

Insights

Request

Query Params

filter

optional

Any of

object

insightType

enum<string>

required

Allowed value:

studentProgress

userId

string

required

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

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CustomInsight

Example:

CustomInsight

attributes

object

optional

relationships

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "CustomInsight",
            "attributes": {
                "insightType": "studentProgress",
                "insightData": [
                    null
                ]
            },
            "relationships": null
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

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

Get Chart

List InsightsTagBreakdowns