Пиксель и события

Список доступных событий Pixel Tag

GET /api/pixel_events/?account_id={account_id}

Описание

Возвращает список событий Pixel Tag, связанных с указанным аккаунтом.

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

GET https://clientapi.adstat.pro/api/pixel_events/?account_id={account_id}

Параметры запроса

Поле	Тип	Описание	Обязательное
account_id	Строка	Идентификатор аккаунта	Да

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

{
  "items": [
    {
      "id": "test_event_some_property",
      "pixel_id": "test_event_some_property",
      "tg_event_id": "test_event_some_property",
      "title": "test_event_some_property",
      "type": "custom",
      "status": "inactive",
      "ads_count": 1,
      "created_at": "2025-06-04T14:36:45+00:00",
      "last_triggered_at": null,
      "code_snippet": "<script>\ntgp('event', 'test_event_some_property');\n</script>"
    }
  ]
}

Описание полей ответа

Поле	Тип	Описание
id	Строка	Идентификатор события
pixel_id	Строка	Идентификатор пикселя
tg_event_id	Строка	Идентификатор события в Telegram
title	Строка	Название события
type	Строка	Тип события (например, custom, page_view)
status	Строка	Статус события (active, inactive)
ads_count	Число	Количество связанных объявлений
created_at	Строка	Дата и время создания события (в формате ISO 8601)
last_triggered_at	Строка	Дата и время последнего срабатывания события (может быть null)
code_snippet	Строка	Код для внедрения события на сайт

---

Создание события

POST /api/pixel_events/

Описание

Создает новое событие Pixel Tag для указанного аккаунта.

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

POST https://clientapi.adstat.pro/api/pixel_events/

Тело запроса

Поле	Тип	Описание	Обязательное
account_id	Строка	Идентификатор аккаунта	Да
title	Строка	Название события	Да
type	Строка	Тип события (из списка типов событий)	Да

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

{
  "account_id": "12345",
  "title": "Purchase",
  "type": "page_view"
}

Возможные ошибки

• 400 Bad Request: Неверный формат данных или отсутствуют обязательные поля.
• 403 Forbidden: Недостаточно прав для создания события.
• 422 Unprocessable Entity: Указан неподдерживаемый тип события.

---

Получение базового кода Pixel Tag

GET /api/pixel_events/{account_id}/code_snippet

Описание

Возвращает базовый код Pixel Tag для указанного аккаунта.

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

GET https://clientapi.adstat.pro/api/pixel_events/{account_id}/code_snippet

Параметры запроса

Поле	Тип	Описание	Обязательное
account_id	Строка	Идентификатор аккаунта	Да

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tg_pixel_id": "pixel_12345",
  "code_snippet": "<script>\n(function(w,d,s,l,i){...})(window,document,'script','dataLayer','pixel_12345');\n</script>"
}

Описание полей ответа

Поле	Тип	Описание
id	Строка	Идентификатор пикселя
tg_pixel_id	Строка	Идентификатор пикселя в Telegram
code_snippet	Строка	Код для внедрения пикселя на сайт

---

Список типов событий

GET /api/pixel_events/types

Описание

Возвращает список доступных типов событий для Pixel Tag.

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

GET https://clientapi.adstat.pro/api/pixel_events/types

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

{
  "items": [
    {
      "type": "page_view",
      "label": "Page View"
    },
    {
      "type": "purchase",
      "label": "Purchase"
    },
    {
      "type": "custom",
      "label": "Custom Event"
    }
  ]
}

Описание полей ответа

Поле	Тип	Описание
type	Строка	Идентификатор типа события
label	Строка	Отображаемое название типа события

---

Редактирование имени события Pixel Tag

PATCH /api/pixel_events/{event_id}

Описание

Изменяет название существующего события Pixel Tag.

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

PATCH https://clientapi.adstat.pro/api/pixel_events/{event_id}

Параметры запроса

Поле	Тип	Описание	Обязательное
event_id	Строка	Идентификатор события	Да

Тело запроса

Поле	Тип	Описание	Обязательное
account_id	Строка	Идентификатор аккаунта	Да
title	Строка	Новое название события	Да

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

{
  "account_id": "12345",
  "title": "Updated Purchase Event"
}

Возможные ошибки

• 400 Bad Request: Неверный формат данных или отсутствуют обязательные поля.
• 403 Forbidden: Недостаточно прав для редактирования события.
• 404 Not Found: Событие с указанным event_id не найдено.

---

Удаление события Pixel Tag

DELETE /api/pixel_events/{account_id}/events/{event_id}

Описание

Удаляет событие Pixel Tag для указанного аккаунта.

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

DELETE https://clientapi.adstat.pro/api/pixel_events/{account_id}/events/{event_id}

Параметры запроса

Поле	Тип	Описание	Обязательное
account_id	Строка	Идентификатор аккаунта	Да
event_id	Строка	Идентификатор события	Да

Возможные ошибки

• 403 Forbidden: Недостаточно прав для удаления события.
• 404 Not Found: Событие или аккаунт не найдены.