Получение статистики аккаунта

Метод используется для получения статистики аккаунта, к которому есть доступ у текущего пользователя.

Метод возвращает информацию для указанного аккаунта, которую можно отображать в виджетах:

Финансовые показатели.
Количество подписок, требующих внимания.
Количество платежей, требующих внимания.
Количество приглашенных пользователей.

GET {reseller_domain}/internal_api/accounts/{account_id}/account_statistic

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, для которого запрашивается статистика

Модель ответа

Название				Тип данных	Описание
data				object	Данные ответа
	id			string	ID аккаунта
	type			string	Тип данных
	attributes			object	Информация о показателях аккаунта
		reseller_currency_iso_code		string	Код валюты реселлера, в которой также представлены все суммы в ответе
		usable_balance		number	Свободные средства на балансе аккаунта
		blocked_amount		number	Сумма, заблокированная на балансе аккаунта
		current_debt		number	Суммарная задолженность по всем подпискам аккаунта по модели Постоплата за текущий финансовый период без учета платежей, выставленных за предыдущий финансовый период
		possible_amount_of_expenses		number	Прогноз потребления на следующий месяц — общая стоимость активных подписок аккаунта, платежи по которым формируются ежемесячно, с учетом налогов
		statistic		object	Информация о статистике аккаунта
			count_active_subscriptions	integer	Число подписок, включая пробные, в статусе Активная, Доставлена, Просрочена оплата, Установка, Активируется, Продление, Обновление, Останавливается, Переключение, Ожидает ручного подтверждения
			count_expiring_subscriptions	integer	Число подписок, включая пробные, до истечения которых осталось 10 и менее дней
			count_unpaid_payments	integer	Число платежей в статусе Ожидает оплаты и Просрочен
			count_guaranteed_payments	integer	Число обещанных платежей в статусе Предоставлен и Предоставлен в связи с пополнением
		sum_guaranteed_payments		integer	Сумма обещанных платежей в статусе Предоставлен и Предоставлен в связи с пополнением
		count_invited_users		integer	Число приглашенных пользователей в статусе Активный — число приглашений, которые еще не были приняты или отозваны (см. Приглашенные пользователи )
		balance_locks		array of objects	Список блокировок баланса в рамках частичной оплаты платежей (см. Частичная оплата платежа с баланса )
			payment_id	integer	ID платежа
			amount	number	Сумма частичной оплаты
			document_id	string	Номер платежа
meta				object	Дополнительная информация
	server_current_time			string	Текущие дата и время сервера

Пример запроса

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1741/account_statistic' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": {
        "id": "1741",
        "type": "account_statistic",
        "attributes": {
            "reseller_currency_iso_code": "USD",
            "usable_balance": 2586.14,
            "blocked_amount": 13176.38,
            "current_debt": 65.65,
            "possible_amount_of_expenses": 177,
            "statistic": {
                "count_active_subscriptions": 21,
                "count_expiring_subscriptions": 1,
                "count_unpaid_payments": 3,
                "count_guaranteed_payments": 0
            },
            "sum_guaranteed_payments": 0,
            "count_invited_users": 0,
            "balance_locks": [
                {
                    "payment_id": 2163,
                    "amount": 22.6,
                    "document_id": "002019"
                }
            ]
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}