TeachersTeacher KPI

Teacher KPI

Teachers · 2 операції

GET

Get teacher KPI

/api/teacher/{id}/kpi-summary

KPI summary of one teacher for a period (view: month, quarter, year or all; date inside the period).

get_teacher_kpi

Параметри шляху · 1

idnumberобовʼязковий—

Параметри запиту · 2

viewstringобовʼязковийОдне з: month quarter year allза замовчуванням all
datestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss · за замовчуванням {}

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject2 поля
periodobjectобовʼязковий4 поля
viewstringобовʼязковийОдне з: year month all quarter
startDatestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
endDatestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
monthsnumberобовʼязковий—
cardsobjectобовʼязковий8 полів
lessonsConductedobjectобовʼязковий3 поля
countnumberобовʼязковий—
perMonthnumberобовʼязковий—
plannedNext30dnumberобовʼязковий—
trialConversionobjectобовʼязковий3 поля
conversionPctnumberобовʼязковий—
purchasednumberобовʼязковий—
trialsnumberобовʼязковий—
completionRateobjectобовʼязковий3 поля
pctnumberобовʼязковий—
completednumberобовʼязковий—
plannednumberобовʼязковий—
realizationobjectобовʼязковий4 поля
totalnumberобовʼязковий—
perMonthnumberобовʼязковий—
avgPerLessonnumberобовʼязковий—
avgPer60minnumberобовʼязковий—
ltLessonsPerStudentobjectобовʼязковий3 поля
valuenumberобовʼязковий—
qualifiedStudentsnumberобовʼязковий—
qualifiedLessonsnumberобовʼязковий—
ltvPerStudentobjectобовʼязковий3 поля
valuenumberобовʼязковий—
totalRealizationnumberобовʼязковий—
qualifiedStudentsnumberобовʼязковий—
schoolMarginobjectобовʼязковий5 полів
pctnumberобовʼязковий—
marginAmountnumberобовʼязковий—
realizationnumberобовʼязковий—
wagesnumberобовʼязковий—
bonusesnumberобовʼязковий—
baseMovementobjectобовʼязковий5 полів
activenumberобовʼязковий—
pausednumberобовʼязковий—
inCirculationnumberобовʼязковий—
arrivednumberобовʼязковий—
leftnumberобовʼязковий—
Помилки400401403429500
curl "https://your-school.rist.pro/api/teacher/1/kpi-summary?view=all&date=%5Bobject%20Object%5D" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "period": {
      "view": "year",
      "startDate": "2026-11-09T14:30:00",
      "endDate": "2026-11-09T14:30:00",
      "months": 0
    },
    "cards": {
      "lessonsConducted": {
        "count": 0,
        "perMonth": 0,
        "plannedNext30d": 0
      },
      "trialConversion": {
        "conversionPct": 0,
        "purchased": 0,
        "trials": 0
      },
      "completionRate": {
        "pct": 0,
        "completed": 0,
        "planned": 0
      },
      "realization": {
        "total": 0,
        "perMonth": 0,
        "avgPerLesson": 0,
        "avgPer60min": 0
      },
      "ltLessonsPerStudent": {
        "value": 0,
        "qualifiedStudents": 0,
        "qualifiedLessons": 0
      },
      "ltvPerStudent": {
        "value": 0,
        "totalRealization": 0,
        "qualifiedStudents": 0
      },
      "schoolMargin": {
        "pct": 0,
        "marginAmount": 0,
        "realization": 0,
        "wages": 0,
        "bonuses": 0
      },
      "baseMovement": {
        "active": 0,
        "paused": 0,
        "inCirculation": 0,
        "arrived": 0,
        "left": 0
      }
    }
  }
}
GET

Get teacher KPI details

/api/teacher/{id}/kpi/{metric}/details

Rows behind one KPI tile of a teacher for the same period as GET /api/teacher/{id}/kpi-summary. metric is one of: lessons-conducted, trial-conversion, completion-rate, realization, lt, ltv, margin, base-movement.

get_teacher_kpi_details

Параметри шляху · 2

idnumberобовʼязковий—
metricstringобовʼязковий—

Параметри запиту · 2

viewstringобовʼязковийОдне з: month quarter year allза замовчуванням all
datestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss · за замовчуванням {}

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject—
Помилки400401403429500
curl "https://your-school.rist.pro/api/teacher/1/kpi/string/details?view=all&date=%5Bobject%20Object%5D" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {}
}