performance
Class-wide rollup for a course.
Class-wide rollup for a course.
OpenAPI specificationPOST
/api/v1/performance/courseAuthentication
bearerAuth
Request
curl --globoff --request POST \
--url 'https://honen.com/api/v1/performance/course' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"courseId": "<courseId>"
}'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.
Request body schema or example
{
"type": "object",
"properties": {
"courseId": {
"type": "string"
}
},
"required": [
"courseId"
]
}Responses
200Command result.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"data": {
"type": "object",
"properties": {
"course": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
]
},
"enrolled": {
"type": "number"
},
"completed": {
"type": "number"
},
"completionPercent": {
"type": "number"
},
"avgQuizPercent": {
"type": "number",
"nullable": true
},
"avgTestPercent": {
"type": "number",
"nullable": true
},
"units": {
"type": "array",
"items": {
"type": "object",
"properties": {
"unitId": {
"type": "string"
},
"unitTitle": {
"type": "string"
},
"totalActivities": {
"type": "number"
},
"attemptedActivities": {
"type": "number"
},
"completedActivities": {
"type": "number"
},
"percentAttempted": {
"type": "number"
},
"percentCompleted": {
"type": "number"
},
"unitTestScore": {
"type": "object",
"properties": {
"score": {
"type": "number"
},
"total": {
"type": "number"
},
"percent": {
"type": "number"
}
},
"required": [
"score",
"total",
"percent"
],
"nullable": true
}
},
"required": [
"unitId",
"unitTitle",
"totalActivities",
"attemptedActivities",
"completedActivities",
"percentAttempted",
"percentCompleted",
"unitTestScore"
]
}
},
"perQuizActivity": {
"type": "array",
"items": {
"type": "object",
"properties": {
"activityId": {
"type": "string"
},
"topicId": {
"type": "string"
},
"topicTitle": {
"type": "string"
},
"unitId": {
"type": "string"
},
"attempts": {
"type": "number"
},
"completedAttempts": {
"type": "number"
},
"avgScore": {
"type": "number",
"nullable": true
},
"avgPercent": {
"type": "number",
"nullable": true
}
},
"required": [
"activityId",
"topicId",
"topicTitle",
"unitId",
"attempts",
"completedAttempts",
"avgScore",
"avgPercent"
]
}
},
"perUnitTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"testId": {
"type": "string"
},
"unitId": {
"type": "string"
},
"unitTitle": {
"type": "string"
},
"attempts": {
"type": "number"
},
"completedAttempts": {
"type": "number"
},
"avgScore": {
"type": "number",
"nullable": true
},
"avgPercent": {
"type": "number",
"nullable": true
}
},
"required": [
"testId",
"unitId",
"unitTitle",
"attempts",
"completedAttempts",
"avgScore",
"avgPercent"
]
}
}
},
"required": [
"course",
"enrolled",
"completed",
"completionPercent",
"avgQuizPercent",
"avgTestPercent",
"units",
"perQuizActivity",
"perUnitTest"
]
}
},
"required": [
"success",
"data"
]
}400Malformed JSON request body.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}401Missing or invalid Connector credentials.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}403Connector policy does not permit this command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}404Unknown command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}422Input validation error.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}