PostHog — продуктовая аналитика: события, персоны, инсайты, флаги функций, эксперименты, опросы и записи сессий.
С PostHog в Pailot вы можете:
- Писать события по одному и пакетом; выполнять запросы HogQL (язык запросов PostHog)
- Смотреть и удалять персон; вести инсайты, дашборды, действия, когорты и аннотации
- Создавать и оценивать флаги функций; вести эксперименты и опросы
- Смотреть записи сессий и плейлисты; править определения событий и свойств
- Читать проекты и организации
Нужен персональный ключ API (Application Programming Interface — программный интерфейс) или ключ проекта (для приёма событий). Регион: us или eu. Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.
Записать одно событие: действие пользователя, просмотр страницы или своё событие.
| Параметр | Тип | Обязательный | Описание |
|---|
projectApiKey | string | Да | Ключ API проекта PostHog (публичный токен для приёма событий) |
region | string | Нет | Регион PostHog: us (по умолчанию) или eu |
event | string | Да | Имя события (например "page_view", "button_clicked") |
distinctId | string | Да | Уникальный ID пользователя или устройства |
properties | string | Нет | JSON свойств события (например {"button_name": "signup", "page": "homepage"}) |
timestamp | string | Нет | Время события в ISO 8601; если нет — текущее |
| Параметр | Тип | Описание |
|---|
status | string | Статус: событие записано |
Записать пакет событий — быстрее, чем по одному.
| Параметр | Тип | Обязательный | Описание |
|---|
projectApiKey | string | Да | Ключ API проекта PostHog (публичный токен для приёма событий) |
region | string | Нет | Регион PostHog: us (по умолчанию) или eu |
batch | string | Да | JSON-массив событий: event, distinct_id и необязательные properties, timestamp. Пример: [{"event": "page_view", "distinct_id": "user123", "properties": {"page": "/"}}] |
| Параметр | Тип | Описание |
|---|
status | string | Статус: пакет записан |
events_processed | number | Число обработанных событий в пакете |
Список персон: профили, свойства и distinct ID.
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | Персональный ключ API PostHog (для авторизованного доступа) |
region | string | Нет | Регион PostHog: us (по умолчанию) или eu |
projectId | string | Да | ID проекта PostHog |
limit | number | Нет | Число персон (по умолчанию 100, макс. 100) |
offset | number | Нет | Сколько персон пропустить |
search | string | Нет | Поиск персон по email, имени или distinct ID |
distinctId | string | Нет | Фильтр по distinct_id |
| Параметр | Тип | Описание |
|---|
persons | array | Персоны: свойства и идентификаторы |
↳ id | string | ID персоны |
↳ name | string | Имя персоны |
↳ distinct_ids | array | Все distinct ID этой персоны |
↳ created_at | string | Когда персону увидели впервые |
↳ uuid | string | UUID персоны |
next | string | URL следующей страницы (если есть) |
Данные персоны по ID или UUID.
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | Персональный ключ API PostHog (для авторизованного доступа) |
region | string | Нет | Регион PostHog: us (по умолчанию) или eu |
projectId | string | Да | ID проекта PostHog |
personId | string | Да | ID или UUID персоны |
| Параметр | Тип | Описание |
|---|
person | object | Данные персоны: свойства и идентификаторы |
↳ id | string | ID персоны |
↳ name | string | Имя персоны |
↳ distinct_ids | array | Все distinct ID этой персоны |
↳ created_at | string | Когда персону увидели впервые |
↳ uuid | string | UUID персоны |
Удалить персону и связанные события. Действие необратимое.
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | Персональный ключ API PostHog (для авторизованного доступа) |
region | string | Нет | Регион PostHog: us (по умолчанию) или eu |
projectId | string | Да | ID проекта PostHog |
personId | string | Да | ID или UUID персоны для удаления |
| Параметр | Тип | Описание |
|---|
status | string | Статус: персона удалена |
Выполнить запрос HogQL — язык запросов PostHog.
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | Персональный ключ API PostHog (для авторизованного доступа) |
region | string | Нет | Регион PostHog: us (по умолчанию) или eu |
projectId | string | Да | ID проекта PostHog |
query | string | Да | Запрос HogQL. Пример: {"kind": "HogQLQuery", "query": "SELECT event, count() FROM events WHERE timestamp > now() - INTERVAL 1 DAY GROUP BY event"} |
Example | string | Нет | Нет описания |
values | string | Нет | JSON значений параметров запроса. Пример: {"user_id": "123"} |
Example | string | Нет | Нет описания |
| Параметр | Тип | Описание |
|---|
results | array | Результаты запроса as an array of rows |
columns | array | Имена колонок результата |
types | array | Типы колонок результата |
hogql | string | Фактически выполненный запрос HogQL |
has_more | boolean | Есть ещё результаты |
Все инсайты проекта: конфигурация, фильтры и метаданные.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Результатов на страницу (по умолчанию 100) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
count | number | Всего инсайтов в проекте |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
results | array | Инсайты: конфигурация и метаданные |
↳ id | number | ID инсайта |
↳ name | string | Имя инсайта |
↳ description | string | Описание инсайта |
↳ filters | object | Фильтры инсайта |
↳ query | object | Запрос инсайта |
↳ created_at | string | Время создания инсайта (ISO) |
↳ created_by | object | Кто создал инсайт |
↳ last_modified_at | string | Время последнего изменения инсайта (ISO) |
↳ last_modified_by | object | Кто последний менял инсайт |
↳ saved | boolean | Инсайт сохранён |
↳ dashboards | array | ID дашбордов, где показан инсайт |
Инсайт по ID: конфигурация, фильтры и метаданные.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
insightId | string | Да | ID инсайта |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
id | number | ID инсайта |
name | string | Имя инсайта |
description | string | Описание инсайта |
filters | object | Фильтры инсайта |
query | object | Запрос инсайта |
created_at | string | Время создания инсайта (ISO) |
created_by | object | Кто создал инсайт |
last_modified_at | string | Время последнего изменения инсайта (ISO) |
last_modified_by | object | Кто последний менял инсайт |
saved | boolean | Инсайт сохранён |
dashboards | array | ID дашбордов, где показан инсайт |
tags | array | Теги инсайта |
favorited | boolean | Инсайт в избранном |
Создать инсайт: имя и фильтры или запрос.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
name | string | Нет | Имя инсайта (если нет — PostHog сгенерирует) |
description | string | Нет | Описание инсайта |
filters | string | Нет | JSON фильтров инсайта |
query | string | Нет | JSON запроса инсайта |
dashboards | string | Нет | ID дашбордов через запятую |
tags | string | Нет | Теги инсайта через запятую |
| Параметр | Тип | Описание |
|---|
id | number | ID созданного инсайта |
name | string | Имя инсайта |
description | string | Описание инсайта |
filters | object | Фильтры инсайта |
query | object | Запрос инсайта |
created_at | string | Время создания инсайта (ISO) |
created_by | object | Кто создал инсайт |
last_modified_at | string | Время последнего изменения инсайта (ISO) |
saved | boolean | Инсайт сохранён |
dashboards | array | ID дашбордов, где показан инсайт |
tags | array | Теги инсайта |
Все дашборды проекта: плитки и метаданные.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Результатов на страницу (по умолчанию 100) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
count | number | Всего дашбордов в проекте |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
results | array | Дашборды: конфигурация и метаданные |
↳ id | number | ID дашборда |
↳ name | string | Имя дашборда |
↳ description | string | Описание дашборда |
↳ pinned | boolean | Дашборд закреплён |
↳ created_at | string | Время создания дашборда (ISO) |
↳ created_by | object | Кто создал дашборд |
↳ last_modified_at | string | Время последнего изменения дашборда (ISO) |
↳ last_modified_by | object | Кто последний менял дашборд |
↳ tiles | array | Плитки дашборда |
↳ filters | object | Глобальные фильтры дашборда |
↳ tags | array | Теги дашборда |
Дашборд по ID: плитки и метаданные.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
dashboardId | string | Да | ID дашборда |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
id | number | ID дашборда |
name | string | Имя дашборда |
description | string | Описание дашборда |
pinned | boolean | Дашборд закреплён |
created_at | string | Время создания дашборда (ISO) |
created_by | object | Кто создал дашборд |
last_modified_at | string | Время последнего изменения дашборда (ISO) |
last_modified_by | object | Кто последний менял дашборд |
tiles | array | Плитки дашборда с настройками |
filters | object | Глобальные фильтры дашборда |
tags | array | Теги дашборда |
restriction_level | number | Уровень ограничения доступа к дашборду |
Все действия проекта: шаги и метаданные.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Результатов на страницу (по умолчанию 100) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
count | number | Всего действий в проекте |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
results | array | Действия: определения и метаданные |
↳ id | number | ID действия |
↳ name | string | Имя действия |
↳ description | string | Описание действия |
↳ tags | array | Теги действия |
↳ post_to_slack | boolean | Публиковать действие в Slack |
↳ slack_message_format | string | Формат сообщений Slack |
↳ steps | array | Шаги, которые задают действие |
↳ created_at | string | Время создания действия (ISO) |
↳ created_by | object | Кто создал действие |
↳ deleted | boolean | Действие удалено |
↳ is_calculating | boolean | Действие сейчас пересчитывается |
↳ last_calculated_at | string | Время последнего расчёта (ISO) |
Все когорты проекта: фильтры и число пользователей.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Результатов на страницу (по умолчанию 100) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
count | number | Всего когорт в проекте |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
results | array | Когорты: определения и метаданные |
↳ id | number | ID когорты |
↳ name | string | Имя когорты |
↳ description | string | Описание когорты |
↳ groups | array | Группы, которые задают когорту |
↳ deleted | boolean | Когорта удалена |
↳ filters | object | Фильтры когорты |
↳ query | object | Запрос когорты |
↳ created_at | string | Время создания когорты (ISO) |
↳ created_by | object | Кто создал когорту |
↳ is_calculating | boolean | Когорта сейчас пересчитывается |
↳ last_calculation | string | Время последнего расчёта (ISO) |
↳ errors_calculating | number | Число ошибок при расчёте |
↳ count | number | Число пользователей в когорте |
↳ is_static | boolean | Статическая когорта |
Когорта по ID: определение, фильтры и число пользователей.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
cohortId | string | Да | ID когорты |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
id | number | ID когорты |
name | string | Имя когорты |
description | string | Описание когорты |
groups | array | Группы, которые задают когорту |
deleted | boolean | Когорта удалена |
filters | object | Фильтры когорты |
query | object | Запрос когорты |
created_at | string | Время создания когорты (ISO) |
created_by | object | Кто создал когорту |
is_calculating | boolean | Когорта сейчас пересчитывается |
last_calculation | string | Время последнего расчёта (ISO) |
errors_calculating | number | Число ошибок при расчёте |
count | number | Число пользователей в когорте |
is_static | boolean | Статическая когорта |
version | number | Номер версии когорты |
Создать когорту: имя и фильтр или запрос.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
name | string | Нет | Имя когорты (если нет — Untitled cohort) |
description | string | Нет | Описание когорты |
filters | string | Нет | JSON фильтров когорты |
query | string | Нет | JSON запроса когорты |
is_static | boolean | Нет | Статическая когорта (по умолчанию false) |
groups | string | Нет | JSON групп когорты |
| Параметр | Тип | Описание |
|---|
id | number | ID созданной когорты |
name | string | Имя когорты |
description | string | Описание когорты |
groups | array | Группы, которые задают когорту |
deleted | boolean | Когорта удалена |
filters | object | Фильтры когорты |
query | object | Запрос когорты |
created_at | string | Время создания когорты (ISO) |
created_by | object | Кто создал когорту |
is_calculating | boolean | Когорта сейчас пересчитывается |
count | number | Число пользователей в когорте |
is_static | boolean | Статическая когорта |
version | number | Номер версии когорты |
Все аннотации проекта: текст, время и связанные инсайты.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Результатов на страницу (по умолчанию 100) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
count | number | Всего аннотаций в проекте |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
results | array | Аннотации: текст и метаданные |
↳ id | number | ID аннотации |
↳ content | string | Текст аннотации |
↳ date_marker | string | Момент, к которому относится аннотация (ISO) |
↳ created_at | string | Время создания аннотации (ISO) |
↳ updated_at | string | Время последнего обновления аннотации (ISO) |
↳ created_by | object | Кто создал аннотацию |
↳ dashboard_item | number | ID плитки дашборда, к которой привязана аннотация |
↳ insight_short_id | string | Короткий ID инсайта аннотации |
↳ insight_name | string | Имя инсайта аннотации |
↳ scope | string | Область аннотации (project или dashboard) |
↳ deleted | boolean | Аннотация удалена |
Создать аннотацию на графике: дата и текст.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
content | string | Да | Текст аннотации |
date_marker | string | Да | Момент аннотации ISO (например "2024-01-15T10:00:00Z") |
scope | string | Нет | Область: project или dashboard_item (по умолчанию project) |
dashboard_item | string | Нет | ID плитки дашборда для привязки |
insight_short_id | string | Нет | Короткий ID инсайта для привязки |
| Параметр | Тип | Описание |
|---|
id | number | ID созданной аннотации |
content | string | Текст аннотации |
date_marker | string | Момент, к которому относится аннотация (ISO) |
created_at | string | Время создания аннотации (ISO) |
updated_at | string | Время последнего обновления аннотации (ISO) |
created_by | object | Кто создал аннотацию |
dashboard_item | number | ID плитки дашборда, к которой привязана аннотация |
insight_short_id | string | Короткий ID инсайта аннотации |
insight_name | string | Имя инсайта аннотации |
scope | string | Область аннотации (project или dashboard_item) |
deleted | boolean | Аннотация удалена |
Все флаги функций проекта.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
limit | number | Нет | Сколько результатов вернуть |
offset | number | Нет | Сколько результатов пропустить |
| Параметр | Тип | Описание |
|---|
results | array | Список флагов функций |
↳ id | number | ID флага функции |
↳ name | string | Имя флага функции |
↳ key | string | Ключ флага функции |
↳ filters | object | Фильтры флага функции |
↳ deleted | boolean | Флаг удалён |
↳ active | boolean | Флаг активен |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ is_simple_flag | boolean | Простой флаг |
↳ rollout_percentage | number | Процент раскатки (если есть) |
↳ ensure_experience_continuity | boolean | Сохранять непрерывность опыта |
count | number | Всего флагов функций |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
Данные флага функции.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
flagId | string | Да | ID флага функции |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
| Параметр | Тип | Описание |
|---|
flag | object | Данные флага функции |
↳ id | number | ID флага функции |
↳ name | string | Имя флага функции |
↳ key | string | Ключ флага функции |
↳ filters | object | Фильтры флага функции |
↳ deleted | boolean | Флаг удалён |
↳ active | boolean | Флаг активен |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ is_simple_flag | boolean | Простой флаг |
↳ rollout_percentage | number | Процент раскатки (если есть) |
↳ ensure_experience_continuity | boolean | Сохранять непрерывность опыта |
↳ usage_dashboard | number | ID дашборда использования |
↳ has_enriched_analytics | boolean | Включена расширенная аналитика |
Создать флаг функции.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
name | string | Нет | Имя флага функции (optional - can be empty) |
key | string | Да | Ключ флага функции (уникальный) |
filters | string | Нет | Фильтры флага функции (JSON-строка) |
active | boolean | Нет | Флаг активен (по умолчанию true) |
ensureExperienceContinuity | boolean | Нет | Сохранять непрерывность опыта (по умолчанию false) |
rolloutPercentage | number | Нет | Процент раскатки (0–100) |
| Параметр | Тип | Описание |
|---|
flag | object | Созданный флаг функции |
↳ id | number | ID флага функции |
↳ name | string | Имя флага функции |
↳ key | string | Ключ флага функции |
↳ filters | object | Фильтры флага функции |
↳ deleted | boolean | Флаг удалён |
↳ active | boolean | Флаг активен |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ is_simple_flag | boolean | Простой флаг |
↳ rollout_percentage | number | Процент раскатки (если есть) |
↳ ensure_experience_continuity | boolean | Сохранять непрерывность опыта |
Обновить флаг функции.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
flagId | string | Да | ID флага функции |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
name | string | Нет | Имя флага функции |
key | string | Нет | Ключ флага функции (уникальный) |
filters | string | Нет | Фильтры флага функции (JSON-строка) |
active | boolean | Нет | Флаг активен |
ensureExperienceContinuity | boolean | Нет | Сохранять непрерывность опыта |
rolloutPercentage | number | Нет | Процент раскатки (0–100) |
| Параметр | Тип | Описание |
|---|
flag | object | Обновлённый флаг функции |
↳ id | number | ID флага функции |
↳ name | string | Имя флага функции |
↳ key | string | Ключ флага функции |
↳ filters | object | Фильтры флага функции |
↳ deleted | boolean | Флаг удалён |
↳ active | boolean | Флаг активен |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ is_simple_flag | boolean | Простой флаг |
↳ rollout_percentage | number | Процент раскатки (если есть) |
↳ ensure_experience_continuity | boolean | Сохранять непрерывность опыта |
Удалить флаг функции.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
flagId | string | Да | ID флага функции для удаления |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
| Параметр | Тип | Описание |
|---|
success | boolean | Удаление успешно |
message | string | Подтверждение |
Оценить флаги для пользователя или группы. Публичный метод, ключ проекта.
| Параметр | Тип | Обязательный | Описание |
|---|
region | string | Да | Облачный регион PostHog: us или eu |
projectApiKey | string | Да | Ключ API проекта PostHog (не персональный ключ) |
distinctId | string | Да | distinct ID пользователя для оценки флагов |
groups | string | Нет | Группы (JSON-строка, например {"company": "company_id_in_your_db"}) |
personProperties | string | Нет | Свойства персоны (JSON-строка) |
groupProperties | string | Нет | Свойства группы (JSON-строка) |
| Параметр | Тип | Описание |
|---|
feature_flags | object | Оценки флагов (ключ — булево или вариант-строка) |
feature_flag_payloads | object | Дополнительные payload флагов |
errors_while_computing_flags | boolean | Были ошибки при расчёте флагов |
Все эксперименты проекта.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
limit | number | Нет | Сколько результатов вернуть |
offset | number | Нет | Сколько результатов пропустить |
| Параметр | Тип | Описание |
|---|
results | array | Список экспериментов |
↳ id | number | ID эксперимента |
↳ name | string | Имя эксперимента |
↳ description | string | Описание эксперимента |
↳ feature_flag_key | string | Ключ связанного флага |
↳ feature_flag | object | Данные флага функции |
↳ parameters | object | Параметры эксперимента |
↳ filters | object | Фильтры эксперимента |
↳ variants | object | Варианты эксперимента |
↳ start_date | string | Дата начала |
↳ end_date | string | Дата окончания |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ archived | boolean | Эксперимент в архиве |
count | number | Всего экспериментов |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
Данные эксперимента.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
experimentId | string | Да | ID эксперимента |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
| Параметр | Тип | Описание |
|---|
experiment | object | Данные эксперимента |
↳ id | number | ID эксперимента |
↳ name | string | Имя эксперимента |
↳ description | string | Описание эксперимента |
↳ feature_flag_key | string | Ключ связанного флага |
↳ feature_flag | object | Данные флага функции |
↳ parameters | object | Параметры эксперимента |
↳ filters | object | Фильтры эксперимента |
↳ variants | object | Варианты эксперимента |
↳ start_date | string | Дата начала |
↳ end_date | string | Дата окончания |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ archived | boolean | Эксперимент в архиве |
↳ metrics | array | Основные метрики |
↳ metrics_secondary | array | Дополнительные метрики |
Создать эксперимент.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
name | string | Нет | Имя эксперимента (необязательно) |
description | string | Нет | Описание эксперимента |
featureFlagKey | string | Да | Ключ флага для эксперимента |
parameters | string | Нет | Параметры эксперимента (JSON-строка) |
filters | string | Нет | Фильтры эксперимента (JSON-строка) |
variants | string | Нет | Варианты эксперимента (JSON-строка) |
startDate | string | Нет | Дата начала эксперимента (ISO) |
endDate | string | Нет | Дата окончания эксперимента (ISO) |
| Параметр | Тип | Описание |
|---|
experiment | object | Созданный эксперимент |
↳ id | number | ID эксперимента |
↳ name | string | Имя эксперимента |
↳ description | string | Описание эксперимента |
↳ feature_flag_key | string | Ключ связанного флага |
↳ feature_flag | object | Данные флага функции |
↳ parameters | object | Параметры эксперимента |
↳ filters | object | Фильтры эксперимента |
↳ variants | object | Варианты эксперимента |
↳ start_date | string | Дата начала |
↳ end_date | string | Дата окончания |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ archived | boolean | Эксперимент в архиве |
Все опросы проекта — сбор обратной связи.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Сколько результатов вернуть (default: 100) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
surveys | array | Опросы проекта |
↳ id | string | ID опроса |
↳ name | string | Имя опроса |
↳ description | string | Описание опроса |
↳ type | string | Тип опроса (popover или api) |
↳ questions | array | Вопросы опроса |
↳ created_at | string | Время создания |
↳ start_date | string | Дата начала опроса |
↳ end_date | string | Дата окончания опроса |
↳ archived | boolean | Опрос в архиве |
count | number | Всего опросов |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
Опрос по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
surveyId | string | Да | ID опроса |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
survey | object | Данные опроса |
↳ id | string | ID опроса |
↳ name | string | Имя опроса |
↳ description | string | Описание опроса |
↳ type | string | Тип опроса (popover или api) |
↳ questions | array | Вопросы опроса |
↳ appearance | object | Оформление опроса |
↳ conditions | object | Условия показа опроса |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ start_date | string | Дата начала опроса |
↳ end_date | string | Дата окончания опроса |
↳ archived | boolean | Опрос в архиве |
↳ responses_limit | number | Максимум ответов |
Создать опрос: открытый вопрос, ссылка, оценка, множественный выбор.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
name | string | Нет | Имя опроса (необязательно) |
description | string | Нет | Описание опроса |
type | string | Нет | Тип: popover (в приложении) или api (по умолчанию popover) |
questions | string | Да | JSON-массив вопросов. У каждого: type (open/link/rating/multiple_choice) и текст. Для rating — scale (1–10), lowerBoundLabel, upperBoundLabel. Для multiple_choice — массив choices. Для link — buttonText. |
startDate | string | Нет | Дата начала опроса ISO 8601 |
endDate | string | Нет | Дата окончания опроса ISO 8601 |
appearance | string | Нет | JSON оформления (цвета, позиция) |
conditions | string | Нет | JSON условий показа (совпадение URL) |
targetingFlagFilters | string | Нет | JSON фильтров флага для таргетинга |
linkedFlagId | string | Нет | ID флага для связи с опросом |
responsesLimit | number | Нет | Максимум собираемых ответов |
| Параметр | Тип | Описание |
|---|
survey | object | Созданный опрос |
↳ id | string | ID опроса |
↳ name | string | Имя опроса |
↳ description | string | Описание опроса |
↳ type | string | Тип опроса (popover или api) |
↳ questions | array | Вопросы опроса |
↳ created_at | string | Время создания |
↳ start_date | string | Дата начала опроса |
↳ end_date | string | Дата окончания опроса |
Обновить опрос: вопросы, оформление, условия показа.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
surveyId | string | Да | ID опроса для обновления |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
name | string | Нет | Имя опроса |
description | string | Нет | Описание опроса |
type | string | Нет | Тип опроса: popover или api |
questions | string | Нет | JSON-массив вопросов. У каждого: type (open/link/rating/multiple_choice) и текст вопроса. |
startDate | string | Нет | Дата начала опроса ISO 8601 |
endDate | string | Нет | Дата окончания опроса ISO 8601 |
appearance | string | Нет | JSON оформления (цвета, позиция) |
conditions | string | Нет | JSON условий показа (совпадение URL) |
targetingFlagFilters | string | Нет | JSON фильтров флага для таргетинга |
linkedFlagId | string | Нет | ID флага для связи с опросом |
responsesLimit | number | Нет | Максимум собираемых ответов |
archived | boolean | Нет | Архивировать или разархивировать опрос |
| Параметр | Тип | Описание |
|---|
survey | object | Обновлённый опрос |
↳ id | string | ID опроса |
↳ name | string | Имя опроса |
↳ description | string | Описание опроса |
↳ type | string | Тип опроса (popover или api) |
↳ questions | array | Вопросы опроса |
↳ created_at | string | Время создания |
↳ start_date | string | Дата начала опроса |
↳ end_date | string | Дата окончания опроса |
↳ archived | boolean | Опрос в архиве |
Записи сессий: действия пользователя в приложении.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Сколько результатов вернуть (default: 50) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
recordings | array | Список записей сессий |
↳ id | string | ID записи |
↳ distinct_id | string | distinct ID пользователя |
↳ viewed | boolean | Запись просмотрена |
↳ recording_duration | number | Длительность записи в секундах |
↳ active_seconds | number | Активное время в секундах |
↳ inactive_seconds | number | Неактивное время в секундах |
↳ start_time | string | Начало записи |
↳ end_time | string | Конец записи |
↳ click_count | number | Число кликов |
↳ keypress_count | number | Число нажатий |
↳ console_log_count | number | Число логов консоли |
↳ console_warn_count | number | Число предупреждений консоли |
↳ console_error_count | number | Число ошибок консоли |
↳ person | object | Данные персоны |
count | number | Всего записей |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
Запись сессии по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
recordingId | string | Да | ID записи сессии |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
recording | object | Данные записи сессии |
↳ id | string | ID записи |
↳ distinct_id | string | distinct ID пользователя |
↳ viewed | boolean | Запись просмотрена |
↳ recording_duration | number | Длительность записи в секундах |
↳ active_seconds | number | Активное время в секундах |
↳ inactive_seconds | number | Неактивное время в секундах |
↳ start_time | string | Начало записи |
↳ end_time | string | Конец записи |
↳ click_count | number | Число кликов |
↳ keypress_count | number | Число нажатий |
↳ console_log_count | number | Число логов консоли |
↳ console_warn_count | number | Число предупреждений консоли |
↳ console_error_count | number | Число ошибок консоли |
↳ start_url | string | Стартовый URL записи |
↳ person | object | Данные персоны |
↳ matching_events | array | События во время записи |
Плейлисты записей сессий.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
projectId | string | Да | ID проекта PostHog |
region | string | Нет | Облачный регион PostHog: us или eu (по умолчанию us) |
limit | number | Нет | Сколько результатов вернуть (default: 100) |
offset | number | Нет | Сколько пропустить (постраничный вывод) |
| Параметр | Тип | Описание |
|---|
playlists | array | Плейлисты записей сессий |
↳ id | string | ID плейлиста |
↳ short_id | string | Короткий ID плейлиста |
↳ name | string | Имя плейлиста |
↳ description | string | Описание плейлиста |
↳ created_at | string | Время создания |
↳ created_by | object | Данные создателя |
↳ deleted | boolean | Плейлист удалён |
↳ filters | object | Фильтры плейлиста |
↳ last_modified_at | string | Время последнего изменения |
↳ last_modified_by | object | Кто последний менял |
↳ derived_name | string | Имя, собранное из фильтров |
count | number | Всего плейлистов |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
Определения событий: описание, теги и статистика использования.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
limit | number | Нет | Результатов на страницу (по умолчанию 100) |
offset | number | Нет | Индекс, с которого начать выдачу |
search | string | Нет | Поиск определений событий по имени |
| Параметр | Тип | Описание |
|---|
count | number | Всего определений событий |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
results | array | Список определений событий |
↳ id | string | ID определения события |
↳ name | string | Имя события |
↳ description | string | Описание события |
↳ tags | array | Теги события |
↳ volume_30_day | number | Событий за последние 30 дней |
↳ query_usage_30_day | number | Сколько раз событие запрашивали за 30 дней |
↳ created_at | string | Когда событие создано (ISO) |
↳ last_seen_at | string | Когда событие видели в последний раз (ISO) |
↳ updated_at | string | Когда событие обновили (ISO) |
↳ updated_by | object | Кто последний менял событие |
Определение события по ID: метаданные, статистика, проверка.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
eventDefinitionId | string | Да | ID определения события |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
| Параметр | Тип | Описание |
|---|
id | string | ID определения события |
name | string | Имя события |
description | string | Описание события |
tags | array | Теги события |
volume_30_day | number | Событий за последние 30 дней |
query_usage_30_day | number | Сколько раз событие запрашивали за 30 дней |
created_at | string | Когда событие создано (ISO) |
last_seen_at | string | Когда событие видели в последний раз (ISO) |
updated_at | string | Когда событие обновили (ISO) |
updated_by | object | Кто последний менял событие |
verified | boolean | Событие проверено |
verified_at | string | Когда событие проверили (ISO) |
verified_by | string | Кто проверил событие |
Обновить определение события: описание, теги, признак проверки.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
eventDefinitionId | string | Да | ID определения события для обновления |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
description | string | Нет | Новое описание события |
tags | string | Нет | Теги через запятую |
verified | boolean | Нет | Пометить событие как проверенное |
| Параметр | Тип | Описание |
|---|
id | string | ID определения события |
name | string | Имя события |
description | string | Обновлённое описание события |
tags | array | Обновлённые теги события |
volume_30_day | number | Событий за последние 30 дней |
query_usage_30_day | number | Сколько раз событие запрашивали за 30 дней |
created_at | string | Когда событие создано (ISO) |
last_seen_at | string | Когда событие видели в последний раз (ISO) |
updated_at | string | Когда событие обновили (ISO) |
updated_by | object | Кто последний менял событие |
verified | boolean | Событие проверено |
verified_at | string | Когда событие проверили (ISO) |
verified_by | string | Кто проверил событие |
Определения свойств: описание, теги, тип и статистика.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
limit | number | Нет | Результатов на страницу (по умолчанию 100) |
offset | number | Нет | Индекс, с которого начать выдачу |
search | string | Нет | Поиск определений свойств по имени |
type | string | Нет | Тип свойства: event, person или group |
| Параметр | Тип | Описание |
|---|
count | number | Всего определений свойств |
next | string | URL следующей страницы |
previous | string | URL предыдущей страницы |
results | array | Список определений свойств |
↳ id | string | ID определения свойства |
↳ name | string | Имя свойства |
↳ description | string | Описание свойства |
↳ tags | array | Теги свойства |
↳ is_numerical | boolean | Свойство числовое |
↳ is_seen_on_filtered_events | boolean | Свойство встречается на отфильтрованных событиях |
↳ property_type | string | Тип данных свойства |
↳ type | string | Тип свойства: event, person или group |
↳ volume_30_day | number | Сколько раз свойство встречалось за 30 дней |
↳ query_usage_30_day | number | Сколько раз свойство запрашивали за 30 дней |
↳ created_at | string | Когда свойство создано (ISO) |
↳ updated_at | string | Когда свойство обновили (ISO) |
↳ updated_by | object | Кто последний менял свойство |
Определение свойства по ID: тип, статистика, проверка.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
propertyDefinitionId | string | Да | ID определения свойства |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
| Параметр | Тип | Описание |
|---|
id | string | ID определения свойства |
name | string | Имя свойства |
description | string | Описание свойства |
tags | array | Теги свойства |
is_numerical | boolean | Свойство числовое |
is_seen_on_filtered_events | boolean | Свойство встречается на отфильтрованных событиях |
property_type | string | Тип данных свойства |
type | string | Тип свойства: event, person или group |
volume_30_day | number | Сколько раз свойство встречалось за 30 дней |
query_usage_30_day | number | Сколько раз свойство запрашивали за 30 дней |
created_at | string | Когда свойство создано (ISO) |
updated_at | string | Когда свойство обновили (ISO) |
updated_by | object | Кто последний менял свойство |
verified | boolean | Свойство проверено |
verified_at | string | Когда свойство проверили (ISO) |
verified_by | string | Кто проверил свойство |
example | string | Пример значения свойства |
Обновить определение свойства: описание, теги, тип, проверка.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта PostHog |
propertyDefinitionId | string | Да | ID определения свойства для обновления |
region | string | Да | Облачный регион PostHog: us или eu |
apiKey | string | Да | Персональный ключ API PostHog |
description | string | Нет | Новое описание свойства |
tags | string | Нет | Теги через запятую |
verified | boolean | Нет | Пометить свойство как проверенное |
property_type | string | Нет | Тип данных (например String, Numeric, Boolean, DateTime) |
| Параметр | Тип | Описание |
|---|
id | string | ID определения свойства |
name | string | Имя свойства |
description | string | Обновлённое описание свойства |
tags | array | Обновлённые теги свойства |
is_numerical | boolean | Свойство числовое |
is_seen_on_filtered_events | boolean | Свойство встречается на отфильтрованных событиях |
property_type | string | Тип данных свойства |
type | string | Тип свойства: event, person или group |
volume_30_day | number | Сколько раз свойство встречалось за 30 дней |
query_usage_30_day | number | Сколько раз свойство запрашивали за 30 дней |
created_at | string | Когда свойство создано (ISO) |
updated_at | string | Когда свойство обновили (ISO) |
updated_by | object | Кто последний менял свойство |
verified | boolean | Свойство проверено |
verified_at | string | Когда свойство проверили (ISO) |
verified_by | string | Кто проверил свойство |
example | string | Пример значения свойства |
Все проекты организации: ID, имена, токены API и настройки.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
region | string | Нет | Облачный регион: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
projects | array | Проекты: конфигурация и настройки |
↳ id | number | ID проекта |
↳ uuid | string | UUID проекта |
↳ organization | string | UUID организации |
↳ api_token | string | Токен API проекта для приёма событий |
↳ app_urls | array | Разрешённые URL приложения |
↳ name | string | Имя проекта |
↳ slack_incoming_webhook | string | URL вебхука Slack для уведомлений |
↳ created_at | string | Время создания проекта |
↳ updated_at | string | Время последнего обновления |
↳ anonymize_ips | boolean | Включена анонимизация IP |
↳ completed_snippet_onboarding | boolean | Онбординг сниппета завершён |
↳ ingested_event | boolean | Хотя бы одно событие принято |
↳ test_account_filters | array | Фильтры тестовых аккаунтов |
↳ is_demo | boolean | Демопроект |
↳ timezone | string | Часовой пояс проекта |
↳ data_attributes | array | Пользовательские атрибуты данных |
Проект по ID: конфигурация, настройки и флаги.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | ID проекта (число или UUID) |
apiKey | string | Да | Персональный ключ API PostHog |
region | string | Нет | Облачный регион: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
project | object | Подробности проекта и настройки |
↳ id | number | ID проекта |
↳ uuid | string | UUID проекта |
↳ organization | string | UUID организации |
↳ api_token | string | Токен API проекта для приёма событий |
↳ app_urls | array | Разрешённые URL приложения |
↳ name | string | Имя проекта |
↳ slack_incoming_webhook | string | URL вебхука Slack для уведомлений |
↳ created_at | string | Время создания проекта |
↳ updated_at | string | Время последнего обновления |
↳ anonymize_ips | boolean | Включена анонимизация IP |
↳ completed_snippet_onboarding | boolean | Онбординг сниппета завершён |
↳ ingested_event | boolean | Хотя бы одно событие принято |
↳ test_account_filters | array | Фильтры тестовых аккаунтов |
↳ is_demo | boolean | Демопроект |
↳ timezone | string | Часовой пояс проекта |
↳ data_attributes | array | Пользовательские атрибуты данных |
↳ person_display_name_properties | array | Свойства для отображаемого имени персоны |
↳ correlation_config | object | Настройки корреляционного анализа |
↳ autocapture_opt_out | boolean | Автозахват выключен |
↳ autocapture_exceptions_opt_in | boolean | Автозахват исключений включён |
↳ session_recording_opt_in | boolean | Запись сессий включена |
↳ capture_console_log_opt_in | boolean | Захват логов консоли включён |
↳ capture_performance_opt_in | boolean | Захват производительности включён |
Организации, к которым есть доступ: имя, slug, уровень членства.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Персональный ключ API PostHog |
region | string | Нет | Облачный регион: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
organizations | array | Организации: настройки и функции |
↳ id | string | ID организации (UUID) |
↳ name | string | Имя организации |
↳ slug | string | Slug организации |
↳ created_at | string | Время создания организации |
↳ updated_at | string | Время последнего обновления |
↳ membership_level | number | Уровень членства в организации |
↳ plugins_access_level | number | Уровень доступа к плагинам/приложениям |
↳ teams | array | ID команд организации |
↳ available_product_features | array | Доступные функции продукта и лимиты |
Организация по ID: настройки, функции, использование, команды.
| Параметр | Тип | Обязательный | Описание |
|---|
organizationId | string | Да | ID организации (UUID) |
apiKey | string | Да | Персональный ключ API PostHog |
region | string | Нет | Облачный регион: us или eu (по умолчанию us) |
| Параметр | Тип | Описание |
|---|
organization | object | Подробности организации: настройки и функции |
↳ id | string | ID организации (UUID) |
↳ name | string | Имя организации |
↳ slug | string | Slug организации |
↳ created_at | string | Время создания организации |
↳ updated_at | string | Время последнего обновления |
↳ membership_level | number | Уровень членства в организации |
↳ plugins_access_level | number | Уровень доступа к плагинам/приложениям |
↳ teams | array | ID команд организации |
↳ available_product_features | array | Функции продукта: лимиты и описания |
↳ domain_whitelist | array | Белый список доменов организации |
↳ is_member_join_email_enabled | boolean | Письма о вступлении участников включены |
↳ metadata | object | Метаданные организации |
↳ customer_id | string | ID клиента для биллинга |
↳ available_features | array | Доступные флаги функций организации |
↳ usage | object | Статистика использования организации |