Skip to content

Админ-панель — Реферальная система

Партнёры, приглашённые, статистика и ставки уровней клиентской и бизнес-линии реферальной системы.

Получить показатели реферальной системы

Request

Показатели партнёров с завершённым профилем и подтверждёнными документами за выбранный период. Реквизиты могут быть не заполнены. Изменение рассчитывается относительно предыдущего периода такой же продолжительности. При отсутствии обеих дат используется текущий месяц. Если значение прошлого периода равно нулю, процент изменения равен null.

Security
bearerAuth or jwtCookie
Query
fromstring, (date)^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Начало периода; передаётся вместе с to. Год от 1 до 9999; предыдущий период сравнения также должен попадать в этот диапазон.

tostring, (date)^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Конец периода включительно; передаётся вместе с from. Год от 1 до 9999.

curl -i -X GET \
  'https://felmee.com/api/admin/referral/partners/summary?from=2019-08-24&to=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Показатели получены

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"INVALID_BODY""INVALID_DATE""invalid_body""unauthorized""not_found""slot_unavailable""conflict""BUSINESS_INACTIVE""INSUFFICIENT_FUNDS""REQUISITES_REQUIRED"
dataobject or null(AdminReferralPartnerSummary)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{ "success": true, "message": "Referral partner statistics retrieved successfully", "codeError": null, "error_code": null, "data": { "period": { … }, "active_partners_count": 10, "inactive_partners_count": 2, "total_accrued_rub": 17000, "active_partners_change_percent": 25, "inactive_partners_change_percent": null, "total_accrued_change_percent": 10 } }