analytics
Monthly active creators, course types, creation starts/first publications, and learner start/completion MAU and totals.
Matches the main Analytics page. Omit month for the current calendar month to date in America/New_York. Creator completions mean first publication; learner completions use recorded completion dates. Unique people are counted once per metric within each month. Requires workspace VIEW_ANALYTICS.
OpenAPI specificationPOST
/api/v1/analytics/monthly-overviewAuthentication
bearerAuth
Request
curl --globoff --request POST \
--url 'https://honen.com/api/v1/analytics/monthly-overview' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{}'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": {
"month": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
"description": "Reporting month in YYYY-MM format, from January 2000 through the current month. Defaults to the current month."
}
},
"additionalProperties": false
}Responses
200Command result.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"data": {
"type": "object",
"properties": {
"month": {
"type": "string"
},
"currentMonth": {
"type": "string"
},
"timezone": {
"type": "string"
},
"creation": {
"type": "object",
"properties": {
"activeCreators": {
"type": "number"
},
"coursesStarted": {
"type": "number"
},
"coursesCompleted": {
"type": "number"
},
"courseTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"COURSE",
"ASSESSMENT",
"ATOM"
]
},
"started": {
"type": "number"
},
"completed": {
"type": "number"
}
},
"required": [
"type",
"started",
"completed"
]
}
}
},
"required": [
"activeCreators",
"coursesStarted",
"coursesCompleted",
"courseTypes"
]
},
"learning": {
"type": "object",
"properties": {
"startingLearners": {
"type": "number"
},
"completingLearners": {
"type": "number"
},
"coursesStarted": {
"type": "number"
},
"coursesCompleted": {
"type": "number"
}
},
"required": [
"startingLearners",
"completingLearners",
"coursesStarted",
"coursesCompleted"
]
}
},
"required": [
"month",
"currentMonth",
"timezone",
"creation",
"learning"
]
}
},
"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"
]
}