Получение дневной аналитики по подписке
Метод Get daily analytics используется для получения информации о расходах с детализацией по дням по указанной подписке с оплатой по мере потребления (pay-as-you-go, PAYG) клиента реселлера. Период задается с помощью произвольных дат или выравнивается по финансовым периодам. Состав данных ответа зависит от услуги. Метод возвращает суммы расходов в валюте реселлера.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/analytics_daily
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
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 подписки | |||||||
export_headers | array | Список заголовков для отчета по потреблению | |||||||
key | string | Ключ заголовка | |||||||
type | string | Тип данных | |||||||
items | array | Список ресурсов и расходов | |||||||
billed_day | string | День учета в биллинге (ГГГГ-ММ-ДД) | |||||||
description | string | Дополнительное описание ресурса | |||||||
tags | array | Список тегов ресурса | |||||||
operate_day | string | День фактического потребления (ГГГГ-ММ-ДД) | |||||||
unit_price | string | Цена единицы ресурса | |||||||
duration | string | Объем потребления ресурса | |||||||
discount_amount | string | Сумма скидки | |||||||
total | string | Сумма потребления ресурса | |||||||
taxes_total | string | Сумма налогов | |||||||
category | string | Категория ресурсов | |||||||
resource_name | string | Название ресурса | |||||||
resource_group | string | Ресурсная группа | |||||||
currency | string | Код валюты | |||||||
unit | string | Единицы измерения ресурса | |||||||
Другие параметры ресурса в зависимости услуги |
Пример запроса
GET /api/v3/analytics_daily?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",
"export_headers": [
{
"key": "sku",
"type": "string"
},
{
"key": "category",
"type": "string"
},
{
"key": "subcategory",
"type": "string"
},
{
"key": "resource_name",
"type": "string"
},
{
"key": "description",
"type": "string"
},
{
"key": "currency",
"type": "string"
},
{
"key": "region",
"type": "string"
},
{
"key": "unit",
"type": "string"
},
{
"key": "resource_group",
"type": "string"
},
{
"key": "virtual_machine_name",
"type": "string"
},
{
"key": "duration",
"type": "number"
},
{
"key": "unit_price",
"type": "number"
},
{
"key": "discount_amount",
"type": "number"
},
{
"key": "taxes_total",
"type": "number"
},
{
"key": "total",
"type": "number"
},
{
"key": "operate_day",
"type": "date"
},
{
"key": "billed_day",
"type": "date"
}
],
"items": [
{
"billed_day": "2023-06-30",
"description": "Azure App Service: S1 App",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "0.13664",
"duration": "1.0",
"discount_amount": "0.0",
"total": "0.13664",
"taxes_total": "0.0",
"category": "Azure App Service",
"subcategory": "Azure App Service Standard Plan",
"sku": "011d5795-7609-4c28-8084-cd26374a1d0e",
"resource_name": "S1 App",
"resource_group": "rgportalprd",
"currency": "USD",
"region": "BR South",
"unit": "1 Hour"
},
{
"billed_day": "2023-06-30",
"description": "Storage: P4 LRS Disk",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "10.215072",
"duration": "0.001389",
"discount_amount": "0.0",
"total": "0.014189",
"taxes_total": "0.0",
"category": "Storage",
"subcategory": "Premium SSD Managed Disks",
"sku": "fec1d8d1-cc81-4d54-a391-83e228df4928",
"resource_name": "P4 LRS Disk",
"resource_group": "rgLan",
"currency": "USD",
"region": "BR South",
"unit": "1/Month"
},
{
"billed_day": "2023-06-30",
"description": "Virtual Machines: B4ms",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "0.30128",
"duration": "2.0",
"discount_amount": "0.0",
"total": "0.60256",
"taxes_total": "0.0",
"category": "Virtual Machines",
"subcategory": "Virtual Machines BS Series",
"sku": "f99c993a-da76-4b9b-824a-bd041aff7005",
"resource_name": "B4ms",
"resource_group": "RGLAN",
"currency": "USD",
"region": "BR South",
"unit": "1 Hour"
},
{
"billed_day": "2023-06-30",
"description": "Storage: LRS List and Create Container Operations",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "0.000403",
"duration": "0.0005",
"discount_amount": "0.0",
"total": "0.0",
"taxes_total": "0.0",
"category": "Storage",
"subcategory": "General Block Blob",
"sku": "f8c187bb-5a47-46ae-b874-f186d207fff4",
"resource_name": "LRS List and Create Container Operations",
"resource_group": "rgLan",
"currency": "USD",
"region": "",
"unit": "10K"
},
{
"billed_day": "2023-06-30",
"description": "VPN Gateway: Standard Gateway",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "0.2128",
"duration": "0.838333",
"discount_amount": "0.0",
"total": "0.178397",
"taxes_total": "0.0",
"category": "VPN Gateway",
"subcategory": "VPN Standard Gateway",
"sku": "f246df93-e03d-4e52-ae97-a43e8f3d542c",
"resource_name": "Standard Gateway",
"resource_group": "rgLan",
"currency": "USD",
"region": "",
"unit": "1 Hour"
},
{
"billed_day": "2023-06-30",
"description": "Virtual Network: Basic IPv4 Dynamic Public IP",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "0.00448",
"duration": "1.561666",
"discount_amount": "0.0",
"total": "0.006996",
"taxes_total": "0.0",
"category": "Virtual Network",
"subcategory": "IP Addresses",
"sku": "f114cb19-ea64-40b5-bcd7-aee474b62853",
"resource_name": "Basic IPv4 Dynamic Public IP",
"resource_group": "rgLan",
"currency": "USD",
"region": "",
"unit": "1 Hour"
},
{
"billed_day": "2023-06-30",
"description": "Virtual Machines: D2/DS2",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "0.35392",
"duration": "2.0",
"discount_amount": "0.0",
"total": "0.70784",
"taxes_total": "0.0",
"category": "Virtual Machines",
"subcategory": "Virtual Machines D Series Windows",
"sku": "f084eedf-a23f-46d2-bc24-b913ab919c95",
"resource_name": "D2/DS2",
"resource_group": "RGLAN",
"currency": "USD",
"region": "BR South",
"unit": "1 Hour"
},
{
"billed_day": "2023-06-30",
"description": "Bandwidth: Standard Data Transfer In",
"tags": [],
"operate_day": "2023-06-30",
"unit_price": "0.0",
"duration": "0.00461",
"discount_amount": "0.0",
"total": "0.0",
"taxes_total": "0.0",
"category": "Bandwidth",
"subcategory": "Rtn Preference: MGN",
"sku": "e315c24e-2f54-4668-95ae-5aef18f93125",
"resource_name": "Standard Data Transfer In",
"resource_group": "rgLan",
"currency": "USD",
"region": "BR South",
"unit": "1 GB"
}
]
}
}