DokumentationProdukteArtim Academy LMSSchülerSchüler V1
Kennzahlen eines Kurses
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Die Zahlen, die ein Trainer über seinen Kurs braucht.
Ohne courseId die Summe über alle Kurse, an denen dieses Konto als Trainer hängt. Die Zahlen sind eine Momentaufnahme, keine Zeitreihe.
GET https://students.api.lms.artim-industries.com/v1/analytics
| Methode | GET |
| Basis | students.api.lms.artim-industries.com/v1 |
| Scope | lms.students.analytics:read |
| Antwort | 200 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer lmsapi_… |
Parameter
| Parameter | Ort | Typ | Pflicht | Bedeutung |
|---|---|---|---|---|
courseId | Query | string | nein | Nur dieser Kurs. |
Anfrage
curl "https://students.api.lms.artim-industries.com/v1/analytics" \
-H "Authorization: Bearer lmsapi_…"
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
courseId | string | Der Kurs, oder null bei der Summe. |
students | integer | Wie viele Konten eingeschrieben sind. |
activeStudents | integer | Wie viele davon in den letzten sieben Tagen etwas getan haben. |
avgPercent | number | Der durchschnittliche Fortschritt. |
submissionsPending | integer | Wie viele Abgaben unbewertet liegen. |
codeReviewsPending | integer | Wie viele Code-Einreichungen unbewertet liegen. |
quizAvgScore | number | Das durchschnittliche Quiz-Ergebnis. |
{
"courseId": "crs_1a9f",
"students": 23,
"activeStudents": 17,
"avgPercent": 38.2,
"submissionsPending": 4,
"codeReviewsPending": 2,
"quizAvgScore": 74.5
}
Fehler
| Status | code | Wann |
|---|---|---|
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. Verlängern über https://api.artim-industries.com/v1/oauth/token. |
403 | missing_scope | Das Token trägt den Scope dieses Endpunkts nicht. |
404 | not_found | Der Eintrag gehört nicht zum freigegebenen Akademie — oder die Anfrage kam auf der falschen Subdomain an. |
422 | invalid_request | Ein Parameter hat den falschen Typ oder liegt außerhalb des erlaubten Bereichs. |
429 | rate_limited | Kontingent erschöpft, siehe Retry-After. |
Jede Fehlerantwort trägt dieselbe Hülle: error.code benennt den Fehler, error.message sagt in einem Satz, was fehlt.
Rate Limits
Das Limit gilt pro Team, nicht pro Token.
| Zugang | Produktion | Sandbox |
|---|---|---|
| Hobby | 60 Anfragen/Minute | ohne Limit |
| Developer Mitgliedschaft | 10.000 Anfragen/Minute | ohne Limit |
Bei 429 sagt der Retry-After-Header, wie lange du warten sollst.