Skip to content

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

Request

Возвращает количество зарегистрированных рефералов, их конверсию и количество активных амбассадоров за выбранный период. Изменения сравниваются с непосредственно предшествующим периодом такой же продолжительности. Для конверсии изменение возвращается в процентных пунктах. Требуется роль ADMIN и доступ REFERRAL_PROGRAM уровня READ или FULL.

Security
bearerAuth or jwtCookie
Query
fromstring, (date)required

Первый день выбранного периода включительно.

tostring, (date)required

Последний день выбранного периода включительно.

curl -i -X GET \
  'https://felmee.com/api/admin/referral/stats?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""unauthorized""not_found""conflict""object_modified_by_another_thread""action_too_late""too_many_request""code_is_gone""forbidden""user_blocked"
dataobject or null(AdminReferralStatsData)required

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

Response
{
  "success": true,
  "message": "Referral statistics retrieved successfully",
  "codeError": null,
  "error_code": null,
  "data": {
    "period": { … },
    "total_referrals": 3842,
    "total_referrals_change_percent": 8.2,
    "conversion_percent": 24.6,
    "conversion_change_percentage_points": 2.1,
    "active_ambassadors": 612,
    "active_ambassadors_change_percent": 4.7
  }
}