Analytics

Reports · 6 операцій

GETRevenue and realization/api/analytics/revenue-realizationGETFinances breakdown/api/analytics/financesGETRealization breakdown/api/analytics/realizationGETCompleted lessons breakdown/api/analytics/completed-lessonsGETLead time per stage/api/analytics/lead-stage-durationGETRefusal reasons breakdown/api/analytics/reason-for-refusal

GET

School-wide income or expenses for a period (view: year, quarter or month; date; typeOfOperation), per day or month cell, grouped by account, article, typeOfPayment (cash, card...) or subscription (which packages bring the money; "Base bill" is a wallet top-up). typeOfPayment and subscription cover student payments only.

analytics_finances

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

groupBystringtypeOfPayment and subscription cover student payments only: wages and bonuses have neither.Одне з: account article typeOfPayment subscriptionза замовчуванням account

typeOfOperationstringобовʼязковийОдне з: INCOME TRANSFER ADJUSTMENT EXPENSES REFUND ACCOUNT_TRANSFER

viewstringобовʼязковийОдне з: year quarter monthза замовчуванням year

datestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss · за замовчуванням {}

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

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

dataobject[]2 поля

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

resultsobjectобовʼязковийдовільні ключі

Помилки400401403429500

curl "https://your-school.rist.pro/api/analytics/finances?typeOfOperation=INCOME&view=year&date=%5Bobject%20Object%5D" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/analytics/finances?typeOfOperation=INCOME&view=year&date=%5Bobject%20Object%5D", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/analytics/finances",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "typeOfOperation": "INCOME",
        "view": "year",
        "date": {}
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": [
    {
      "period": "string",
      "results": {}
    }
  ]
}

GET

Realization breakdown

/api/analytics/realization

Value of conducted lessons for a period (view: year, quarter or month; date), grouped by lesson type, subject or teacher (groupBy).

analytics_realization

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

viewstringобовʼязковийОдне з: year quarter monthза замовчуванням year

datestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss · за замовчуванням {}

groupBystringобовʼязковийОдне з: typeOfLesson subject teacherза замовчуванням typeOfLesson

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

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

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

dataobject[]2 поля

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

resultsobjectобовʼязковийдовільні ключі

Помилки400401403429500

curl "https://your-school.rist.pro/api/analytics/realization?view=year&date=%5Bobject%20Object%5D&groupBy=typeOfLesson&typeOfLessonId=1" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/analytics/realization?view=year&date=%5Bobject%20Object%5D&groupBy=typeOfLesson&typeOfLessonId=1", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/analytics/realization",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "view": "year",
        "date": {},
        "groupBy": "typeOfLesson",
        "typeOfLessonId": 1
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": [
    {
      "period": "string",
      "results": {}
    }
  ]
}

GET

Completed lessons breakdown

/api/analytics/completed-lessons

Number of conducted lessons for a period (view: year, quarter or month; date), grouped by lesson type, subject or teacher (groupBy).

analytics_completed_lessons

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

viewstringобовʼязковийОдне з: year quarter monthза замовчуванням year

datestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss · за замовчуванням {}

groupBystringобовʼязковийОдне з: typeOfLesson subject teacherза замовчуванням typeOfLesson

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

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

dataobject[]2 поля

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

resultsobjectобовʼязковийдовільні ключі

Помилки400401403429500

curl "https://your-school.rist.pro/api/analytics/completed-lessons?view=year&date=%5Bobject%20Object%5D&groupBy=typeOfLesson" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/analytics/completed-lessons?view=year&date=%5Bobject%20Object%5D&groupBy=typeOfLesson", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/analytics/completed-lessons",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "view": "year",
        "date": {},
        "groupBy": "typeOfLesson"
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": [
    {
      "period": "string",
      "results": {}
    }
  ]
}

GET

Lead time per stage

/api/analytics/lead-stage-duration

How long leads stay in each pipeline stage for a period (view, date; optional pipelineId).

analytics_lead_stage_duration

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

viewstringобовʼязковийОдне з: year quarter monthза замовчуванням year

datestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss · за замовчуванням {}

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

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

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

dataobject[]11 полів

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

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

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

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

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

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

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

avgDaysnumberобовʼязковийможе бути null—

medianDaysnumberобовʼязковийможе бути null—

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

avgCurrentDaysnumberобовʼязковийможе бути null—

Помилки400401403429500

curl "https://your-school.rist.pro/api/analytics/lead-stage-duration?view=year&date=%5Bobject%20Object%5D&pipelineId=1" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/analytics/lead-stage-duration?view=year&date=%5Bobject%20Object%5D&pipelineId=1", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/analytics/lead-stage-duration",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "view": "year",
        "date": {},
        "pipelineId": 1
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": [
    {
      "stageId": 1,
      "pipelineId": 1,
      "nameOfStage": "string",
      "color": "string",
      "order": 0,
      "stageType": "string",
      "completedCount": 0,
      "avgDays": 0,
      "medianDays": 0,
      "currentCount": 0,
      "avgCurrentDays": 0
    }
  ]
}

GET

Refusal reasons breakdown

/api/analytics/reason-for-refusal

Archived students (not leads) counted by refusal reason over a period (view: year, quarter or month; date). For lost leads by reason use GET /api/lead/breakdown.

analytics_refusal_reasons

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

viewstringобовʼязковийОдне з: year quarter monthза замовчуванням year

datestringобовʼязковийформат YYYY-MM-DDTHH:mm:ss · за замовчуванням {}

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

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

dataobject[]2 поля

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

resultsobjectобовʼязковийдовільні ключі

Помилки400401403429500

curl "https://your-school.rist.pro/api/analytics/reason-for-refusal?view=year&date=%5Bobject%20Object%5D" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/analytics/reason-for-refusal?view=year&date=%5Bobject%20Object%5D", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/analytics/reason-for-refusal",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "view": "year",
        "date": {}
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": [
    {
      "period": "string",
      "results": {}
    }
  ]
}