Получение предварительной дневной аналитики по подписке
Метод Get daily drafts используется для получения информации о предварительных расходах с детализацией по дням по указанной подписке с оплатой по мере потребления (pay-as-you-go, PAYG) клиента реселлера. Период задается с помощью произвольных дат или выравнивается по финансовым периодам. Метод возвращает суммы расходов без разбивки по категориям ресурсов и ресурсам.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/analytics_daily_drafts
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
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 | Опциональный | Предназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД |
Модель ответа
Название | Тип данных | Описание | |||||||
---|---|---|---|---|---|---|---|---|---|
subscription | object | Информация о подписке | |||||||
id | integer | ID подписки | |||||||
items | array of objects | Список расходов | |||||||
billed_day | string | Дата учета в биллинге (ГГГГ-ММ-ДД) | |||||||
total | string | Сумма потребления в валюте реселлера |
Пример запроса
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"
}
]
}
}