Документация LMS версия 0.1.0

Документация/Проект API/Аналитика

Это проектная спецификация, а не работающее API: реализации ещё нет, адреса могут измениться.

Собрано из кода — руками не правится · источник: openapi.draft.json

Аналитика

Операций в разделе: 5.

GET /v1/analytics/courses/{id} #

доходимость по урокам

В пути: id

Параметры:

  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/analytics/courses/crs_01HQZX41B7RC9S' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Коды ответа: 200, 401, 403, 404, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

GET /v1/analytics/funnel #

конверсии между сегментами

Параметры:

  • limit — сколько вернуть, 1…1000, по умолчанию 50
  • cursor — позиция продолжения из next_cursor
  • sort — сортировка, минус для убывания
  • expand — развернуть связи
  • fields — вернуть только эти поля
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/analytics/funnel' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Коды ответа: 200, 401, 403, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

POST /v1/analytics/query #

произвольный запрос по преднастроенным метрикам

Параметры:

  • Idempotency-Key — заголовок, защита от двойного выполнения
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X POST 'https://school.example.com/api/v1/analytics/query' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 6f1e2a34-9c8b-4d7e-a1f0-3b5c7d9e1f2a' \
  -H 'Accept: application/json'

Коды ответа: 201, 400, 401, 403, 409, 422, 429, 500, 503.

Чего здесь нет: тело запроса и состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

GET /v1/analytics/sales #

оборот, оплаты, средний чек по периодам

Параметры:

  • limit — сколько вернуть, 1…1000, по умолчанию 50
  • cursor — позиция продолжения из next_cursor
  • sort — сортировка, минус для убывания
  • expand — развернуть связи
  • fields — вернуть только эти поля
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/analytics/sales' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Коды ответа: 200, 401, 403, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

GET /v1/analytics/traffic #

источники, UTM, окупаемость канала

Параметры:

  • limit — сколько вернуть, 1…1000, по умолчанию 50
  • cursor — позиция продолжения из next_cursor
  • sort — сортировка, минус для убывания
  • expand — развернуть связи
  • fields — вернуть только эти поля
  • X-On-Behalf-Of — заголовок, действие от лица пользователя

Запрос:

curl -X GET 'https://school.example.com/api/v1/analytics/traffic' \
  -H 'Authorization: Bearer lms_live_a8f3c1e9d2b74a5f8e0c1d3b5a7f9e2c' \
  -H 'Accept: application/json'

Коды ответа: 200, 401, 403, 429, 500, 503.

Чего здесь нет: состав полей ответа. Публичного API в продукте пока нет, выводить состав полей не из чего — см. Чего в справочнике ещё нет.

Как выглядит ошибка и что делать с каждым кодом — в разделе Ошибки.

Эта страница в Markdown