Получение информации о расходах реселлера

Метод Get reseller analytics используется для получения информации о расходах реселлера по каждой подписке всех его клиентов за указанный период. Период задается только с помощью произвольных дат.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/reseller_analytics

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url	path	string	Обязательный	URL ActivePlatform
reseller_id	path	integer	Обязательный	ID реселлера (см. Просмотр информации о реселлере)
date_from	query	string	Обязательный	Предназначен для указания даты начала интересующего календарного периода в формате ГГГГ-ММ-ДД
date_to	query	string	Обязательный	Предназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД

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

Название		Тип данных	Описание
expenses		array of objects	Список расходов
	total	string	Сумма расходов по подписке за период в валюте реселлера
	billing_period	string	Дата финансового периода в формате ГГГГ-ММ
	account_id	integer	ID клиента
	subscription_id	integer	ID подписки

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

GET /api/v3/resellers/1/reseller_analytics?date_from=2023-09-01&date_to=2023-09-20
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "expenses": [
        {
            "total": "25.76",
            "period": "2023-06",
            "account_id": 929,
            "subscription_id": 3008386
        },
        {
            "total": "437.0",
            "period": "2023-06",
            "account_id": 1195,
            "subscription_id": 3008458
        }
    ]
}