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

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

GET {reseller_domain}/internal_api/accounts/{account_id}/subscriptions/{subscription_id}/analytics/filters

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, которому принадлежит подписка
subscription_id	path	integer	Обязательный	ID подписки
period_from	query	string	Опциональный	Предназначен для указания первого финансового периода в формате ГГГГ-ММ
period_to	query	string	Опциональный	Предназначен для указания последнего финансового периода в формате ГГГГ-ММ
date_from	query	string	Опциональный	Предназначен для указания даты начала интересующего календарного периода в формате ГГГГ-ММ-ДД
date_to	query	string	Опциональный	Предназначен для указания даты конца интересующего календарного периода в формате ГГГГ-ММ-ДД

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

Название		Тип данных	Описание
filters		array	Список фильтров
	key	string	Ключ фильтра
	scope	string	Скоуп фильтра: tags — фильтр по тегам ресурсов. category — фильтр по категории ресурсов. metadata — все остальные фильтры.
	type	string	Тип данных для значений фильтра. Возможные значения: boolean string array
	values	array	Список значений фильтра Ограничение из-за негативного влияния на производительность: в ответ включается не более 2000 значений фильтров для каждого скоупа. Если в подписке их окажется больше 2000 значений и при получении месячной или дневной аналитики будет применен такой фильтр, отфильтрованные данные о потреблении могут быть неполными.

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

Bash

curl --location -g --request GET 'https://test.activeplatform.com/internal_api/accounts/896/subscriptions/53840/analytics/filters?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

{
    "filters": [
        {
            "key": "category",
            "scope": "category",
            "type": "string",
            "values": [
                "3rd-party resources",
                "Azure RI",
                "Storage",
                "Virtual Machine Licenses"
            ]
        },
        {
            "key": "tags",
            "scope": "tags",
            "type": "array",
            "values": [
                "Owner: Vasil Kewlar 98",
                "Purpose: POC OwnCloud",
                "department: dev",
                "displayName: VirtualMachine",
                "region: USA",
                "tagName: tagValue"
            ]
        },
        {
            "key": "azure_ri_applied",
            "scope": "metadata",
            "type": "boolean",
            "values": [
                true,
                false
            ]
        },
        {
            "key": "resource_group",
            "scope": "metadata",
            "type": "array",
            "values": [
                "NEWRESOURCEGROUP",
                "TN_RESOURCE_CENTRAL_INDIA"
            ]
        },
        {
            "key": "virtual_machine_name",
            "scope": "metadata",
            "type": "array",
            "values": [
                "AzProd6"
            ]
        }
    ]
}