gamification.balance.history

Scope: gamification

Кто может вызывать: Любой авторизованный пользователь. Без прав admin/manager — только своя история (фильтр по USER_ID принудительно ограничивается текущим пользователем). Подробнее: Права доступа

Постраничный список транзакций баланса с фильтрацией в Mongo-стиле.

HTTP: GET

Побочные эффекты: нет

Параметры метода

Параметр Тип Обяз. Описание
filter object нет Фильтр в Mongo-стиле по полям таблицы транзакций
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет Вернуть все записи одним ответом (защитный лимит 5000)

Возвращаемые данные

result.result — массив записей транзакций. result.total — общее количество.

Поля каждой записи зависят от структуры таблицы транзакций (ID, USER_ID, AMOUNT, CURRENCY, OPERATION_TYPE, DATE_CREATE и др.).

Обработка ошибок

Справочник кодов ошибок.

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Попытка просмотра чужой истории без соответствующих прав
INVALID_LIMIT Некорректное значение limit
INVALID_OFFSET Некорректное значение offset
INVALID_FILTER Некорректный фильтр
FETCHALL_LIMIT_EXCEEDED Превышен защитный лимит при fetchAll=true

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/gamification.balance.history.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=10" \
          --data-urlencode "offset=0"
        

Пример ответа:

{
          "result": {
            "result": [
              {
                "ID": "42",
                "USER_ID": "1",
                "AMOUNT": "100",
                "CURRENCY": "BAL",
                "OPERATION_TYPE": "accrual",
                "DATE_CREATE": "2026-08-01T10:00:00+03:00"
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }
        
Предыдущая
Следующая