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

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

GET {reseller_domain}/internal_api/accounts/{account_id}/subscriptions/{subscription_id}/analytics/monthly

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, которому принадлежит подписка
subscription_id	path	integer	Обязательный	ID подписки
period_from	query	string	Опциональный	Предназначен для указания первого финансового периода в формате ГГГГ-ММ
period_to	query	string	Опциональный	Предназначен для указания последнего финансового периода в формате ГГГГ-ММ
date_from	query	string	Опциональный	Предназначен для указания даты начала интересующего календарного периода в формате ГГГГ-ММ-ДД
date_to	query	string	Опциональный	Предназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД
filters	query	string	Опциональный	Предназначен для фильтрации данных: Можно указать несколько значений фильтра через запятую. Данные в ответе могут соответствовать любому из указанных значений. Можно указать несколько фильтров. Данные в ответе соответствуют всем указанным фильтрам одновременно. Для каждого фильтра обязательно укажите скоуп и ключ в формате `filters[<скоуп>][<ключ>]` (см. Получение списка фильтров для аналитики). Если указанный фильтр не может быть применен к данным, возвращается пустой ответ.

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

Название			Тип данных	Описание
billing_periods			array	Список финансовых периодов (ГГГГ-ММ), для которых в `items` есть данные о потреблении (предварительные или финальные)
subscription			object	Информация о подписке
	id		string	ID подписки
	items		array	Список ресурсов и расходов
		category	string	Категория ресурсов
		resource_name	string	Название ресурса
		billing_period	string	Финансовый период (ГГГГ-ММ)
		total	string	Сумма расходов
	closed_financial_periods		array	Список закрытых финансовых периодов (ГГГГ-ММ) для подписки. Потребление в закрытом финансовом периоде считается финальным, иначе — предварительным

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

Bash

curl --location -g --request GET 'https://test.activeplatform.com/internal_api/accounts/2653/subscriptions/3017451/analytics/monthly?period_from=2025-01&period_to=2025-03' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "billing_periods": [
        "2025-01",
        "2025-02"
    ],
    "subscription": {
        "id": "3017451",
        "items": [
            {
                "category": "Virtual Machines",
                "resource_name": "D4 v3/D4s v3",
                "billing_period": "2025-01",
                "total": "631.792941"
            },
            {
                "category": "Event Hubs",
                "resource_name": "Standard Throughput Unit",
                "billing_period": "2025-02",
                "total": "4.705882"
            },
            {
                "category": "Storage",
                "resource_name": "All Other Operations",
                "billing_period": "2025-02",
                "total": "4.705882"
            }
        ],
        "closed_financial_periods": [
            "2024-11",
            "2024-12"
        ]
    }
}