Создание шаблона фильтров

Метод используется для создания шаблона фильтров данных аналитики для текущего пользователя.

Метод возвращает информацию о созданном шаблоне фильтров. Код ответа 201 Created.

POST {reseller_domain}/internal_api/user_templates/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	Обязательный	Доменное имя реселлера
name			form	string	Обязательный	Название шаблона фильтров (до 200 символов)
filter_template			form	object	Обязательный	Параметры шаблона фильтров
	account_id		form	integer	Опциональный	ID аккаунта
	subscription_id		form	integer	Опциональный	ID подписки
	filters		form	array of objects	Обязательный	Список фильтров в шаблоне. Доступные фильтры и их параметры см. в Получение списка фильтров для аналитики
		key	form	string	Обязательный	Ключ фильтра
		type	form	string	Обязательный	Скоуп фильтра
		value	form	Зависит от фильтра	Обязательный	Установленные значения фильтра

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

Название					Тип данных	Описание
data					object	Данные ответа
	id				string	ID шаблона фильтров
	type				string	Тип данных
	attributes				object	Информация о шаблоне фильтров
		created_at			string	Дата и время создания шаблона фильтров
		name			string	Название шаблона фильтров
		filter_template			object	Параметры шаблона фильтров
			account_id		integer	ID аккаунта
			subscription_id		integer	ID подписки
			filters		array of objects	Список фильтров в шаблоне
				key	string	Ключ фильтра
				type	string	Скоуп фильтра
				value	Зависит от фильтра	Установленные значения фильтра
meta					object	Дополнительная информация
	server_current_time				string	Текущие дата и время сервера

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

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/user_templates/analytics/filters' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data '{
  "data": {
    "attributes": {
      "name": "3rd-party resources+tags+Azure RI",
      "filter_template": {
        "account_id": 525,
        "subscription_id": 2810,
        "filters": [
          {
            "key": "category",
            "type": "category",
            "value": "3rd-party resources"
          },
          {
            "key": "tags",
            "type": "tags",
            "value": [
              "Purpose: POC OwnCloud"
            ]
          },
          {
            "key": "reserved",
            "type": "metadata",
            "value": true
          }
        ]
      }
    }
  }
}'

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

JSON

{
    "data": {
        "id": "65",
        "type": "user_templates",
        "attributes": {
            "created_at": "2024-04-12T09:06:45.520+03:00",
            "name": "3rd-party resources+tags+Azure RI",
            "filter_template": {
                "account_id": 525,
                "subscription_id": 2810,
                "filters": [
                    {
                        "key": "category",
                        "type": "category",
                        "value": "3rd-party resources"
                    },
                    {
                        "key": "tags",
                        "type": "tags",
                        "value": [
                            "Purpose: POC OwnCloud"
                        ]
                    },
                    {
                        "key": "reserved",
                        "type": "metadata",
                        "value": true
                    }
                ]
            }
        }
    },
    "meta": {
        "server_current_time": "2024-04-12T09:06:45.536814+0300"
    }
}