Работа с кабинетами

Список кабинетов

INFO

GET accounts/telegram/names

Пример использования:

https://client.adstat.pro/api/accounts/telegram/names

Параметры:

В заголовках HTTP запроса необходимо передать <access_token> в формате:

• Authorization: "Bearer <access_token>"

Пример успешного ответа:

[
	{
		"account_uid": "ACC0000",
		"name": "string",
		"balance": 0,
		"mode": "string",
		"is_audience_allowed": false
	}
]

Описание параметров успешного ответа:

Параметр	Описание
account_uid	Идентификатор кабинета
name	Наименование кабинета
balance	Баланс кабинета
mode	Внутренний параметр для технических нужд
is_audience_allowed	Внутренний параметр для технических нужд

Информация по отдельному кабинету

INFO

GET api/accounts/telegram/{account_uid}

Пример использования:

https://client.adstat.pro/api/accounts/telegram/ACC0000

Параметры:

В заголовках HTTP запроса необходимо передать <access_token> в формате:

• Authorization: "Bearer <access_token>"

В URL метода необходимо передать Идентификатор кабинета - account_uid, который можно узнать из списка всех кабинетов

Пример успешного ответа:

{
	"account_uid": "ACC0000",
	"name": "string",
	"balance": 0,
	"mode": "string",
	"is_audience_allowed": false
}

Описание параметров успешного ответа:

Параметр	Описание
account_uid	Идентификатор кабинета
name	Наименование кабинета
balance	Баланс кабинета
mode	Внутренний параметр для технических нужд
is_audience_allowed	Внутренний параметр для технических нужд

Подробная информация по кабинетам

INFO

GET accounts/telegram/?query-params

Пример использования:

https://client.adstat.pro/api/accounts/telegram/?limit=50&offset=0

Описание query-параметров:

Параметр	Тип	Описание
account_name	Строка	Фильтрация кабинетов по названию кабинета.
offset	Число	Смещение в результирующем списке кабинетов.
limit	Число	Максимальное количество кабинетов в ответе.
legal_name	Строка	Фильтрация кабинетов по юридическому названию.

Пример успешного ответа:

{
	"items": [
		{
			"account_id": "ACC0000",
			"account_name": "account name",
			"status": "active",
			"balance_total": 0,
			"balance_available": 0,
			"balance_active": 0,
			"balance_spent": 0,
			"objects": ["t.me/example"],
			"legal_name": "legal name",
			"category_key": "education",
			"category_name": "Образование"
		}
	],
	"count": 1
}

Описание параметров успешного ответа:

Поле	Тип	Описание
items	Массив	Список объектов с информацией о кабинетах.
account_id	Строка	Уникальный идентификатор кабинета.
account_name	Строка	Название кабинета.
status	Строка	Статус кабинета. active, inactive
balance_total	Число	Общий баланс кабинета.
balance_available	Число	Свободный баланс кабинета.
balance_active	Число	Баланс остатка средств в объявлениях кабинета.
balance_spent	Число	Потраченный баланс кабинета.
objects	Массив	Список объектов рекламирования привязанных к кабинету.
legal_name	Строка	Юридическое название кабинета.
category_key	Строка	Ключ категории кабинета.
category_name	Строка	Название категории кабинета.
count	Число	Количество кабинетов в списке.

Вот улучшенная и стилистически выверенная версия текста:

ККТУ по умолчанию для кабинета

Метод позволяет назначить ККТУ по умолчанию для кабинета. Если при создании рекламной кампании (РК) ККТУ не указан вручную, и для кабинета настроен ККТУ по умолчанию — он будет автоматически применён к создаваемой РК.

Метод:

PATCH /api/accounts/set-default-kktu

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

https://client.adstat.pro/api/accounts/set-default-kktu

Параметры запроса (body):

Параметр	Тип	Описание
account_id	string	Уникальный идентификатор кабинета
kktu_id	string	Уникальный идентификатор ККТУ

Пример тела запроса:

{
	"account_id": "string",
	"kktu_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}