Получение месячной аналитики по подписке

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

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

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

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

GET {base_url}/api/v3/analytics_monthly

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
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
subscription_id	query	string	Обязательный	ID подписки
period_from	query	string	Опциональный	Предназначен для указания первого финансового периода в формате ГГГГ-ММ
period_to	query	string	Опциональный	Предназначен для указания последнего финансового периода в формате ГГГГ-ММ
date_from	query	string	Опциональный	Предназначен для указания даты начала интересующего календарного периода в формате ГГГГ-ММ-ДД
date_to	query	string	Опциональный	Предназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД

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

Название			Тип данных	Описание
billing_periods			array	Список финансовых периодов (ГГГГ-ММ)
subscription			object	Информация о подписке
	id		integer	ID подписки
	items		array	Список ресурсов и расходов
		resource_group	string	Название ресурсной группы
		category	string	Категория ресурсов
		resource_name	string	Название ресурса
		tags	array	Список тегов ресурсов
		billing_period	string	Финансовый период (ГГГГ-ММ)
		total	string	Сумма расходов

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

GET /api/v3/analytics_monthly?subscription_id=53840&period_from=2023-06&period_to=2023-07
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "billing_periods": [
        "2023-06",
        "2023-07"
    ],
    "subscription": {
        "id": "53840",
        "items": [
            {
                "resource_group": "PDFParanaGLM",
                "category": "Storage",
                "resource_name": "Batch Write Operations",
                "tags": [],
                "billing_period": "2023-06",
                "total": "0.0"
            },
            {
                "resource_group": "PDFParanaGLM",
                "category": "Storage",
                "resource_name": "LRS Data Stored",
                "tags": [],
                "billing_period": "2023-06",
                "total": "0.898459"
            },
            {
                "resource_group": "RGLAN",
                "category": "Virtual Machines",
                "resource_name": "B2s",
                "tags": [
                    "Veeam backup appliance ID: 2bkea35c-1243-abcd-9f12-ecc129f5f0d0",
                    "veeam01: dfgni2MJCI"
                ],
                "billing_period": "2023-06",
                "total": "0.150528"
            }
        ]
    }
}