Получение динамики расходов аккаунта

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

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

GET {reseller_domain}/internal_api/accounts/{account_id}/analytics/expenses

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

Авторизация

Требуется авторизация с помощью 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	Опциональный	Предназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД

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

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

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1741/analytics/expenses?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

{
  "expenses": [
    {
      "total": "6.595945",
      "billing_period": "2023-06"
    },
    {
      "total": "6552.567333",
      "billing_period": "2023-07"
    }
  ]
}