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

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

GET {reseller_domain}/internal_api/accounts/{account_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 аккаунта, для которого запрашивается статистика подписок
period_from	query	string	Опциональный	Предназначен для указания первого финансового периода в формате ГГГГ-ММ
period_to	query	string	Опциональный	Предназначен для указания последнего финансового периода в формате ГГГГ-ММ
date_from	query	string	Опциональный	Предназначен для указания даты начала интересующего календарного периода в формате ГГГГ-ММ-ДД
date_to	query	string	Опциональный	Предназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД

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

Название			Тип данных	Описание
billing_periods			array	Список финансовых периодов (ГГГГ-ММ), в которых есть потребление по подпискам
subscriptions			array	Список подписок, по которым есть потребление в указанном периоде
	id		integer	ID подписки
	items		array	Список ресурсов и расходов
		category	string	Категория ресурсов
		resource_name	string	Название ресурса
		billing_period	string	Финансовый период (ГГГГ-ММ)
		total	string	Сумма расходов
	name		string	Название подписки
	billing_type		string	Тип биллинга тарифного плана, на который заказана подписка

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

Bash

curl --location -g --request GET 'https://test.activeplatform.com/internal_api/accounts/896/analytics/monthly?period_from=2023-06&period_to=2023-07' \
--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": [
        "2023-06",
        "2023-07"
    ],
    "subscriptions": [
        {
            "id": 3011012,
            "items": [
                {
                    "category": "",
                    "resource_name": "Res1",
                    "billing_period": "2023-06",
                    "total": "1.03"
                },
                {
                    "category": "",
                    "resource_name": "Res2",
                    "billing_period": "2023-07",
                    "total": "0.53"
                }
            ],
            "name": "ALL - CSP Monthly (csp_monthly)",
            "billing_type": "csp_monthly"
        },
        {
            "id": 3011011,
            "items": [
                {
                    "category": "",
                    "resource_name": "res3",
                    "billing_period": "2023-06",
                    "total": "4.18"
                },
                {
                    "category": "",
                    "resource_name": "res4",
                    "billing_period": "2023-06",
                    "total": "1.67"
                }
            ],
            "name": "ALL - Monthly Commitment (monthly_commitment)",
            "billing_type": "monthly_commitment"
        },
        {
            "id": 3010154,
            "items": [
                {
                    "category": "Storage",
                    "resource_name": "Disk Operations",
                    "billing_period": "2023-06",
                    "total": "239642.305883"
                },
                {
                    "category": "Virtual Machine Licenses",
                    "resource_name": "ownCloud Certified by Bitnami - ownCloud Certified by Bitnami - 1 Core Hours",
                    "billing_period": "2023-06",
                    "total": "27560.0"
                }
            ],
            "name": "Bel AzurePlan test",
            "billing_type": "pay_as_you_go_external"
        },
        {
            "id": 3010155,
            "items": [
                {
                    "category": "Storage",
                    "resource_name": "Disk Operations",
                    "billing_period": "2023-07",
                    "total": "174531.94353"
                },
                {
                    "category": "Virtual Machine Licenses",
                    "resource_name": "ownCloud Certified by Bitnami - ownCloud Certified by Bitnami - 1 Core Hours",
                    "billing_period": "2023-07",
                    "total": "20072.0"
                }
            ],
            "name": "Bel AzurePlan",
            "billing_type": "pay_as_you_go_external"
        }
    ]
}