Получение предварительной дневной аналитики по подписке

Метод Get daily drafts используется для получения информации о предварительных расходах с детализацией по дням по указанной подписке с оплатой по мере потребления (pay-as-you-go, PAYG) клиента реселлера. Период задается с помощью произвольных дат или выравнивается по финансовым периодам. Метод возвращает суммы расходов без разбивки по категориям ресурсов и ресурсам.

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

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

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

GET {base_url}/api/v3/analytics_daily_drafts

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
subscription_idquerystringОбязательныйID подписки
period_fromquerystringОпциональныйПредназначен для указания первого финансового периода в формате ГГГГ-ММ
period_toquerystringОпциональныйПредназначен для указания последнего финансового периода в формате ГГГГ-ММ
date_fromquerystringОпциональныйПредназначен для указания даты начала интересующего календарного периода в формате ГГГГ-ММ-ДД 
date_toquerystringОпциональныйПредназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД 

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

Название

Тип данных

Описание

subscriptionobjectИнформация о подписке

idintegerID подписки

itemsarray of objectsСписок расходов


billed_daystringДата учета в биллинге (ГГГГ-ММ-ДД)


totalstringСумма потребления в валюте реселлера

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

GET /api/v3/analytics_daily_drafts?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

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

{
  "subscription": {
    "id": "53840",
    "items": [
      {
        "billed_day": "2023-07-04",
        "total": "139.240562"
      },
      {
        "billed_day": "2023-07-05",
        "total": "139.248279"
      }
    ]
  }
}