List InsightsTagBreakdowns

GET

/insights-tag-breakdowns

Request

Query Params

cohort

enum<string>

required

The type of cohort to filter the insights data by

Allowed values:

userportaluserGroup

type

enum<string>

optional

The level to which the data is aggregated. This will default to match the cohort provided. Some combinations are not supported. For exam aggregating by usergroup for a whole portal

Allowed values:

userportaluserGroup

targetId

string

required

timeFrameUnit

enum<string>

required

Allowed values:

daysweeksmonthsyears

timeFrameAmount

number

required

>= 1

tagSetId

string | null

optional

tagBreakdowns

array[string]

optional

Allowed values:

exammodulesubjecttopicsubtopicdifficultyskillcontext

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.synap.ac/v3/insights-tag-breakdowns?cohort=&targetId=&timeFrameUnit=&timeFrameAmount='

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (InsightsTagBreakdown) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

InsightsTagBreakdown

Example:

InsightsTagBreakdown

attributes

object

optional

relationships

object

optional

meta

object

optional

lastUpdated

string <date-time>

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "InsightsTagBreakdown",
            "attributes": {
                "subject": "string",
                "topic": "string",
                "subTopic": "string",
                "skill": "string",
                "difficulty": "string",
                "responseCount": 0,
                "sumScore": 0,
                "maxScore": 0,
                "timeFrameStart": "2019-08-24T14:15:22Z",
                "timeFrameEnd": "2019-08-24T14:15:22Z"
            },
            "relationships": {
                "user": {
                    "data": {
                        "id": "FID001",
                        "type": "User"
                    }
                },
                "userGroup": {
                    "data": {
                        "id": "FID001",
                        "type": "UserGroup"
                    }
                },
                "tagSet": {
                    "data": {
                        "id": "FID001",
                        "type": "TagSet"
                    }
                }
            }
        }
    ],
    "meta": {
        "lastUpdated": "2019-08-24T14:15:22Z"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

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

List CustomInsights

Create Integration