Инструмент PostHog встраивает мощную продуктовую аналитику, управление feature-флагами, экспериментирование и анализ поведения пользователей прямо в ваши воркфлоу. Созданный для современных команд, он позволяет фиксировать, анализировать и действовать на основе пользовательских данных в реальном времени — помогая создавать лучшие продукты, понимать вовлечённость и увеличивать конверсии.
Инструмент PostHog позволяет:
- Отслеживание и анализ событий: используйте операции
posthog_capture_event и posthog_batch_events, чтобы записывать отдельные или массовые действия пользователей, просмотры страниц или пользовательские события для глубокой аналитики.
- Исследование данных событий: получайте и просматривайте исторические или текущие события с помощью операции
posthog_list_events для расширенного анализа.
- Понимание пользователей: используйте операции
posthog_list_persons, posthog_get_person и posthog_delete_person для управления профилями пользователей, получения детальной информации о них или удаления при необходимости.
- Получение продуктовых инсайтов: визуализируйте пользовательские сценарии, использование функций и вовлечённость через операции
posthog_list_insights, posthog_get_insight и posthog_create_insight.
- Безопасный roll-out функций: включайте/выключайте функции и проводите A/B- или multivariate-тесты в масштабе с помощью операций
posthog_list_feature_flags, posthog_get_feature_flag, posthog_create_feature_flag, posthog_update_feature_flag и posthog_delete_feature_flag.
- Сегментация и таргетинг аудитории: создавайте, получайте и управляйте когортами с помощью
posthog_list_cohorts, posthog_get_cohort и posthog_create_cohort.
- Сбор прямой обратной связи: проектируйте, разворачивайте и анализируйте опросы через
posthog_list_surveys, posthog_get_survey, posthog_create_survey и posthog_update_survey.
- Мониторинг пользовательского опыта: получайте и анализируйте записи сессий через операции
posthog_list_session_recordings и posthog_get_session_recording.
- Командная совместная работа: организуйте дашборды (
posthog_list_dashboards, posthog_get_dashboard), создавайте и аннотируйте инсайты и события, управляйте проектами и организациями внутри PostHog.
Хотите ли вы внедрить полноценную продуктовую аналитику, улучшить онбординг пользователей, доработать roadmap продукта или автоматизировать решения на основе реальных данных использования — инструмент PostHog даёт вашим агентам и воркфлоу расширенную аналитику и продуктовое экспериментирование на единой платформе.
Ищете настоящую продуктовую аналитику с упором на приватность, масштабируемость и open-source? PostHog используют быстрорастущие команды и крупные компании по всему миру.
Интегрируйте PostHog в ваш рабочий процесс. Отслеживать events, manage feature flags, analyze user behavior, run experiments, create surveys, и access session recordings.
Зафиксируйте одно событие в PostHog. Use this to track user actions, page views, или пользовательские events.
| Параметр | Тип | Обязательный | Описание |
|---|
projectApiKey | string | Да | PostHog Project API Key (public token for event ingestion) |
region | string | Нет | PostHog region: us (default) or eu |
event | string | Да | Имя события для захвата (e.g., "page_view", "button_clicked") |
distinctId | string | Да | Unique identifier for the user or device (e.g., "user123", email, or device UUID) |
properties | string | Нет | JSON string of event properties (e.g., {"button_name": "signup", "page": "homepage"}) |
timestamp | string | Нет | ISO 8601 timestamp for when the event occurred. Если не предоставлен, uses current time |
| Параметр | Тип | Описание |
|---|
status | string | Status message indicating whether the event was captured successfully |
Capture multiple events at once in PostHog. Use this для bulk event ingestion to improve performance.
| Параметр | Тип | Обязательный | Описание |
|---|
projectApiKey | string | Да | PostHog Project API Key (public token for event ingestion) |
region | string | Нет | PostHog region: us (default) or eu |
batch | string | Да | JSON array of events to capture. Each event should have: event, distinct_id, and optional properties, timestamp. Example: [{"event": "page_view", "distinct_id": "user123", "properties": {"page": "/"}}] |
| Параметр | Тип | Описание |
|---|
status | string | Status message indicating whether the batch was captured successfully |
events_processed | number | Number of events processed in the batch |
Список persons (users) in PostHog. Returns user profiles С помощьюir properties и distinct IDs.
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | PostHog Personal API Key (for authenticated API access) |
region | string | Нет | PostHog region: us (default) or eu |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
limit | number | Нет | Number of persons to return (default: 100, max: 100) |
offset | number | Нет | Number of persons to skip for постраничная выборка (e.g., 0, 100, 200) |
search | string | Нет | Search persons by email, name, or distinct ID |
distinctId | string | Нет | Filter by specific distinct_id |
| Параметр | Тип | Описание |
|---|
persons | array | List of persons С помощьюir properties and identifiers |
↳ id | string | Person ID |
↳ name | string | Person name |
↳ distinct_ids | array | All distinct IDs associated with this person |
↳ created_at | string | When the person was first seen |
↳ uuid | string | Person UUID |
next | string | URL for the next page of results (if available) |
Получить подробную информацию about a specific person in PostHog by their ID или UUID.
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | PostHog Personal API Key (for authenticated API access) |
region | string | Нет | PostHog region: us (default) or eu |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
personId | string | Да | Person ID or UUID to retrieve (e.g., "01234567-89ab-cdef-0123-456789abcdef") |
| Параметр | Тип | Описание |
|---|
person | object | Person details including properties and identifiers |
↳ id | string | Person ID |
↳ name | string | Person name |
↳ distinct_ids | array | All distinct IDs associated with this person |
↳ created_at | string | When the person was first seen |
↳ uuid | string | Person UUID |
Удалить person from PostHog. This will remove all associated events и data. Use с caution.
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | PostHog Personal API Key (for authenticated API access) |
region | string | Нет | PostHog region: us (default) or eu |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
personId | string | Да | Person ID or UUID to delete (e.g., "01234567-89ab-cdef-0123-456789abcdef") |
| Параметр | Тип | Описание |
|---|
status | string | Status message indicating whether the person was deleted successfully |
Выполнить a HogQL запрос in PostHog. HogQL — это PostHog
| Параметр | Тип | Обязательный | Описание |
|---|
personalApiKey | string | Да | PostHog Personal API Key (for authenticated API access) |
region | string | Нет | PostHog region: us (default) or eu |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
query | string | Да | HogQL query to execute. Example: {"kind": "HogQLQuery", "query": "SELECT event, count() FROM events WHERE timestamp > now() - INTERVAL 1 DAY GROUP BY event"} |
values | string | Нет | Optional JSON string of parameter values for parameterized queries. Example: {"user_id": "123"} |
| Параметр | Тип | Описание |
|---|
results | array | Query results as an array of rows |
columns | array | Column names in the result set |
types | array | Data types of columns in the result set |
hogql | string | The actual HogQL query that was executed |
has_more | boolean | Произошла лиre are more results available |
Список всех insights in a PostHog project. Returns insight configurations, filters, и metadata.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
limit | number | Нет | Количество результатов для возврата per page (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
count | number | Total number of insights in the project |
next | string | URL for the next page of results |
previous | string | URL for the previous page of results |
results | array | List of insights С помощьюir configurations and metadata |
↳ id | number | Unique identifier for the insight |
↳ name | string | Name of the insight |
↳ description | string | Description of the insight |
↳ filters | object | Filter configuration for the insight |
↳ query | object | Query configuration for the insight |
↳ created_at | string | ISO timestamp when insight was created |
↳ created_by | object | User who created the insight |
↳ last_modified_at | string | ISO timestamp when insight was last modified |
↳ last_modified_by | object | User who last modified the insight |
↳ saved | boolean | Произошла ли insight is saved |
↳ dashboards | array | IDs of dashboards this insight appears on |
Получить a specific insight от ID from PostHog. Returns detailed insight configuration, filters, и metadata.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
insightId | string | Да | The insight ID to retrieve (e.g., "42" or short ID like "abc123") |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
| Параметр | Тип | Описание |
|---|
id | number | Unique identifier for the insight |
name | string | Name of the insight |
description | string | Description of the insight |
filters | object | Filter configuration for the insight |
query | object | Query configuration for the insight |
created_at | string | ISO timestamp when insight was created |
created_by | object | User who created the insight |
last_modified_at | string | ISO timestamp when insight was last modified |
last_modified_by | object | User who last modified the insight |
saved | boolean | Произошла ли insight is saved |
dashboards | array | IDs of dashboards this insight appears on |
tags | array | Tags associated С помощью insight |
favorited | boolean | Произошла ли insight is favorited |
Создать новый insight in PostHog. Требуется insight name и configuration filters или запрос.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
name | string | Нет | Name for the insight (optional - PostHog will generate a derived name if not provided) |
description | string | Нет | Description of the insight |
filters | string | Нет | JSON string of filter configuration for the insight |
query | string | Нет | JSON string of query configuration for the insight |
dashboards | string | Нет | Comma-separated list of dashboard IDs to add this insight to |
tags | string | Нет | Comma-separated list of tags for the insight |
| Параметр | Тип | Описание |
|---|
id | number | Unique identifier for the created insight |
name | string | Name of the insight |
description | string | Description of the insight |
filters | object | Filter configuration for the insight |
query | object | Query configuration for the insight |
created_at | string | ISO timestamp when insight was created |
created_by | object | User who created the insight |
last_modified_at | string | ISO timestamp when insight was last modified |
saved | boolean | Произошла ли insight is saved |
dashboards | array | IDs of dashboards this insight appears on |
tags | array | Tags associated С помощью insight |
Список всех dashboards in a PostHog project. Returns dashboard configurations, tiles, и metadata.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
limit | number | Нет | Количество результатов для возврата per page (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
count | number | Total number of dashboards in the project |
next | string | URL for the next page of results |
previous | string | URL for the previous page of results |
results | array | List of dashboards С помощьюir configurations and metadata |
↳ id | number | Unique identifier for the dashboard |
↳ name | string | Name of the dashboard |
↳ description | string | Description of the dashboard |
↳ pinned | boolean | Произошла ли dashboard is pinned |
↳ created_at | string | ISO timestamp when dashboard was created |
↳ created_by | object | User who created the dashboard |
↳ last_modified_at | string | ISO timestamp when dashboard was last modified |
↳ last_modified_by | object | User who last modified the dashboard |
↳ tiles | array | Tiles/widgets on the dashboard |
↳ filters | object | Global filters for the dashboard |
↳ tags | array | Tags associated С помощью dashboard |
Получить a specific dashboard от ID from PostHog. Returns detailed dashboard configuration, tiles, и metadata.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
dashboardId | string | Да | The dashboard ID to retrieve (e.g., "42") |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
| Параметр | Тип | Описание |
|---|
id | number | Unique identifier for the dashboard |
name | string | Name of the dashboard |
description | string | Description of the dashboard |
pinned | boolean | Произошла ли dashboard is pinned |
created_at | string | ISO timestamp when dashboard was created |
created_by | object | User who created the dashboard |
last_modified_at | string | ISO timestamp when dashboard was last modified |
last_modified_by | object | User who last modified the dashboard |
tiles | array | Tiles/widgets on the dashboard С помощьюir configurations |
filters | object | Global filters applied to the dashboard |
tags | array | Tags associated С помощью dashboard |
restriction_level | number | Access restriction level for the dashboard |
Список всех actions in a PostHog project. Returns action definitions, steps, и metadata.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
limit | number | Нет | Количество результатов для возврата per page (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
count | number | Total number of actions in the project |
next | string | URL for the next page of results |
previous | string | URL for the previous page of results |
results | array | List of actions С помощьюir definitions and metadata |
↳ id | number | Unique identifier for the action |
↳ name | string | Name of the action |
↳ description | string | Description of the action |
↳ tags | array | Tags associated С помощью action |
↳ post_to_slack | boolean | Whether to post this action to Slack |
↳ slack_message_format | string | Format string for Slack messages |
↳ steps | array | Steps that define the action |
↳ created_at | string | ISO timestamp when action was created |
↳ created_by | object | User who created the action |
↳ deleted | boolean | Произошла ли action is deleted |
↳ is_calculating | boolean | Произошла ли action is being calculated |
↳ last_calculated_at | string | ISO timestamp of last calculation |
Список всех cohorts in a PostHog project. Returns cohort definitions, filters, и user counts.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
limit | number | Нет | Количество результатов для возврата per page (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
count | number | Total number of cohorts in the project |
next | string | URL for the next page of results |
previous | string | URL for the previous page of results |
results | array | List of cohorts С помощьюir definitions and metadata |
↳ id | number | Unique identifier for the cohort |
↳ name | string | Name of the cohort |
↳ description | string | Description of the cohort |
↳ groups | array | Groups that define the cohort |
↳ deleted | boolean | Произошла ли cohort is deleted |
↳ filters | object | Filter configuration for the cohort |
↳ query | object | Query configuration for the cohort |
↳ created_at | string | ISO timestamp when cohort was created |
↳ created_by | object | User who created the cohort |
↳ is_calculating | boolean | Произошла ли cohort is being calculated |
↳ last_calculation | string | ISO timestamp of last calculation |
↳ errors_calculating | number | Number of errors during calculation |
↳ count | number | Number of users in the cohort |
↳ is_static | boolean | Произошла ли cohort is static |
Получить a specific cohort от ID from PostHog. Returns detailed cohort definition, filters, и user count.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
cohortId | string | Да | The cohort ID to retrieve (e.g., "42") |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
| Параметр | Тип | Описание |
|---|
id | number | Unique identifier for the cohort |
name | string | Name of the cohort |
description | string | Description of the cohort |
groups | array | Groups that define the cohort |
deleted | boolean | Произошла ли cohort is deleted |
filters | object | Filter configuration for the cohort |
query | object | Query configuration for the cohort |
created_at | string | ISO timestamp when cohort was created |
created_by | object | User who created the cohort |
is_calculating | boolean | Произошла ли cohort is being calculated |
last_calculation | string | ISO timestamp of last calculation |
errors_calculating | number | Number of errors during calculation |
count | number | Number of users in the cohort |
is_static | boolean | Произошла ли cohort is static |
version | number | Version number of the cohort |
Создать новый cohort in PostHog. Требуется cohort name и filter или запрос configuration.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
name | string | Нет | Name for the cohort (optional - PostHog will use "Untitled cohort" if not provided) |
description | string | Нет | Description of the cohort |
filters | string | Нет | JSON string of filter configuration for the cohort |
query | string | Нет | JSON string of query configuration for the cohort |
is_static | boolean | Нет | Произошла ли cohort is static (default: false) |
groups | string | Нет | JSON string of groups that define the cohort |
| Параметр | Тип | Описание |
|---|
id | number | Unique identifier for the created cohort |
name | string | Name of the cohort |
description | string | Description of the cohort |
groups | array | Groups that define the cohort |
deleted | boolean | Произошла ли cohort is deleted |
filters | object | Filter configuration for the cohort |
query | object | Query configuration for the cohort |
created_at | string | ISO timestamp when cohort was created |
created_by | object | User who created the cohort |
is_calculating | boolean | Произошла ли cohort is being calculated |
count | number | Number of users in the cohort |
is_static | boolean | Произошла ли cohort is static |
version | number | Version number of the cohort |
Список всех annotations in a PostHog project. Returns annotation content, timestamps, и associated insights.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
limit | number | Нет | Количество результатов для возврата per page (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
count | number | Total number of annotations in the project |
next | string | URL for the next page of results |
previous | string | URL for the previous page of results |
results | array | List of annotations С помощьюir content and metadata |
↳ id | number | Unique identifier for the annotation |
↳ content | string | Content/text of the annotation |
↳ date_marker | string | ISO timestamp marking when the annotation applies |
↳ created_at | string | ISO timestamp when annotation was created |
↳ updated_at | string | ISO timestamp when annotation was last updated |
↳ created_by | object | User who created the annotation |
↳ dashboard_item | number | ID of dashboard item this annotation is attached to |
↳ insight_short_id | string | Short ID of the insight this annotation is attached to |
↳ insight_name | string | Name of the insight this annotation is attached to |
↳ scope | string | Scope of the annotation (project or dashboard) |
↳ deleted | boolean | Произошла ли annotation is deleted |
Создать новый annotation in PostHog. Mark important events on your graphs с date и description.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: "us" or "eu" (default: "us") |
content | string | Да | Content/text of the annotation |
date_marker | string | Да | ISO timestamp marking when the annotation applies (e.g., "2024-01-15T10:00:00Z") |
scope | string | Нет | Scope of the annotation: "project" or "dashboard_item" (default: "project") |
dashboard_item | string | Нет | ID of dashboard item to attach this annotation to |
insight_short_id | string | Нет | Short ID of the insight to attach this annotation to |
| Параметр | Тип | Описание |
|---|
id | number | Unique identifier for the created annotation |
content | string | Content/text of the annotation |
date_marker | string | ISO timestamp marking when the annotation applies |
created_at | string | ISO timestamp when annotation was created |
updated_at | string | ISO timestamp when annotation was last updated |
created_by | object | User who created the annotation |
dashboard_item | number | ID of dashboard item this annotation is attached to |
insight_short_id | string | Short ID of the insight this annotation is attached to |
insight_name | string | Name of the insight this annotation is attached to |
scope | string | Scope of the annotation (project or dashboard_item) |
deleted | boolean | Произошла ли annotation is deleted |
Список всех feature flags in a PostHog project
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
limit | number | Нет | Количество результатов для возврата (e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
results | array | List of feature flags |
↳ id | number | Feature flag ID |
↳ name | string | Feature flag name |
↳ key | string | Feature flag key |
↳ filters | object | Feature flag filters |
↳ deleted | boolean | Произошла ли flag is deleted |
↳ active | boolean | Произошла ли flag is active |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ is_simple_flag | boolean | Произошла ли эта is a simple flag |
↳ rollout_percentage | number | Rollout percentage (if applicable) |
↳ ensure_experience_continuity | boolean | Whether to ensure experience continuity |
count | number | Total number of feature flags |
next | string | URL to next page of results |
previous | string | URL to previous page of results |
Получить details of a specific feature flag
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
flagId | string | Да | The feature flag ID (e.g., "42") |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
| Параметр | Тип | Описание |
|---|
flag | object | Feature flag details |
↳ id | number | Feature flag ID |
↳ name | string | Feature flag name |
↳ key | string | Feature flag key |
↳ filters | object | Feature flag filters |
↳ deleted | boolean | Произошла ли flag is deleted |
↳ active | boolean | Произошла ли flag is active |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ is_simple_flag | boolean | Произошла ли эта is a simple flag |
↳ rollout_percentage | number | Rollout percentage (if applicable) |
↳ ensure_experience_continuity | boolean | Whether to ensure experience continuity |
↳ usage_dashboard | number | Usage dashboard ID |
↳ has_enriched_analytics | boolean | Whether enriched analytics are enabled |
Создать новый feature flag in PostHog
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
name | string | Нет | Feature flag name (optional - can be empty) |
key | string | Да | Feature flag key (unique identifier) |
filters | string | Нет | Feature flag filters as JSON string |
active | boolean | Нет | Произошла ли flag is active (default: true) |
ensureExperienceContinuity | boolean | Нет | Whether to ensure experience continuity (default: false) |
rolloutPercentage | number | Нет | Rollout percentage (0-100) |
| Параметр | Тип | Описание |
|---|
flag | object | Created feature flag |
↳ id | number | Feature flag ID |
↳ name | string | Feature flag name |
↳ key | string | Feature flag key |
↳ filters | object | Feature flag filters |
↳ deleted | boolean | Произошла ли flag is deleted |
↳ active | boolean | Произошла ли flag is active |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ is_simple_flag | boolean | Произошла ли эта is a simple flag |
↳ rollout_percentage | number | Rollout percentage (if applicable) |
↳ ensure_experience_continuity | boolean | Whether to ensure experience continuity |
Обновитьn existing feature flag in PostHog
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
flagId | string | Да | The feature flag ID (e.g., "42") |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
name | string | Нет | Feature flag name |
key | string | Нет | Feature flag key (unique identifier) |
filters | string | Нет | Feature flag filters as JSON string |
active | boolean | Нет | Произошла ли flag is active |
ensureExperienceContinuity | boolean | Нет | Whether to ensure experience continuity |
rolloutPercentage | number | Нет | Rollout percentage (0-100) |
| Параметр | Тип | Описание |
|---|
flag | object | Updated feature flag |
↳ id | number | Feature flag ID |
↳ name | string | Feature flag name |
↳ key | string | Feature flag key |
↳ filters | object | Feature flag filters |
↳ deleted | boolean | Произошла ли flag is deleted |
↳ active | boolean | Произошла ли flag is active |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ is_simple_flag | boolean | Произошла ли эта is a simple flag |
↳ rollout_percentage | number | Rollout percentage (if applicable) |
↳ ensure_experience_continuity | boolean | Whether to ensure experience continuity |
Удалить feature flag from PostHog
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
flagId | string | Да | The feature flag ID to delete (e.g., "42") |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
| Параметр | Тип | Описание |
|---|
success | boolean | Произошла ли deletion was successful |
message | string | Confirmation message |
Evaluate feature flags для a specific user или group. This — это public endpoint that uses the project API ключ.
| Параметр | Тип | Обязательный | Описание |
|---|
region | string | Да | PostHog cloud region: us or eu |
projectApiKey | string | Да | PostHog Project API Key (not personal API key) |
distinctId | string | Да | The distinct ID of the user to evaluate flags for (e.g., "user123" or email) |
groups | string | Нет | Groups as JSON string (e.g., {"company": "company_id_in_your_db"}) |
personProperties | string | Нет | Person properties as JSON string |
groupProperties | string | Нет | Group properties as JSON string |
| Параметр | Тип | Описание |
|---|
feature_flags | object | Feature flag evaluations (key-value pairs where values are boolean or string variants) |
feature_flag_payloads | object | Additional payloads attached to feature flags |
errors_while_computing_flags | boolean | Произошла лиre were errors while computing flags |
Список всех experiments in a PostHog project
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
limit | number | Нет | Количество результатов для возврата (e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
results | array | List of experiments |
↳ id | number | Experiment ID |
↳ name | string | Experiment name |
↳ description | string | Experiment description |
↳ feature_flag_key | string | Associated feature flag key |
↳ feature_flag | object | Feature flag details |
↳ parameters | object | Experiment parameters |
↳ filters | object | Experiment filters |
↳ variants | object | Experiment variants |
↳ start_date | string | Start date |
↳ end_date | string | End date |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ archived | boolean | Произошла ли experiment is archived |
count | number | Total number of experiments |
next | string | URL to next page of results |
previous | string | URL to previous page of results |
Получить details of a specific experiment
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
experimentId | string | Да | The experiment ID (e.g., "42") |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
| Параметр | Тип | Описание |
|---|
experiment | object | Experiment details |
↳ id | number | Experiment ID |
↳ name | string | Experiment name |
↳ description | string | Experiment description |
↳ feature_flag_key | string | Associated feature flag key |
↳ feature_flag | object | Feature flag details |
↳ parameters | object | Experiment parameters |
↳ filters | object | Experiment filters |
↳ variants | object | Experiment variants |
↳ start_date | string | Start date |
↳ end_date | string | End date |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ archived | boolean | Произошла ли experiment is archived |
↳ metrics | array | Primary metrics |
↳ metrics_secondary | array | Secondary metrics |
Создать новый experiment in PostHog
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | The PostHog project ID (e.g., "12345" or project UUID) |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
name | string | Нет | Experiment name (optional) |
description | string | Нет | Experiment description |
featureFlagKey | string | Да | Feature flag key to use for the experiment |
parameters | string | Нет | Experiment parameters as JSON string |
filters | string | Нет | Experiment filters as JSON string |
variants | string | Нет | Experiment variants as JSON string |
startDate | string | Нет | Experiment start date (ISO format) |
endDate | string | Нет | Experiment end date (ISO format) |
| Параметр | Тип | Описание |
|---|
experiment | object | Created experiment |
↳ id | number | Experiment ID |
↳ name | string | Experiment name |
↳ description | string | Experiment description |
↳ feature_flag_key | string | Associated feature flag key |
↳ feature_flag | object | Feature flag details |
↳ parameters | object | Experiment parameters |
↳ filters | object | Experiment filters |
↳ variants | object | Experiment variants |
↳ start_date | string | Start date |
↳ end_date | string | End date |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ archived | boolean | Произошла ли experiment is archived |
Список всех surveys in a PostHog project. Surveys allow you to collect feedback from users.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: us or eu (default: us) |
limit | number | Нет | Количество результатов для возврата (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
surveys | array | List of surveys in the project |
↳ id | string | Survey ID |
↳ name | string | Survey name |
↳ description | string | Survey description |
↳ type | string | Survey type (popover or api) |
↳ questions | array | Survey questions |
↳ created_at | string | Creation timestamp |
↳ start_date | string | Survey start date |
↳ end_date | string | Survey end date |
↳ archived | boolean | Whether survey is archived |
count | number | Total number of surveys |
next | string | URL for next page of results |
previous | string | URL for previous page of results |
Получить details of a specific survey in PostHog от ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
surveyId | string | Да | Survey ID to retrieve (e.g., "01234567-89ab-cdef-0123-456789abcdef") |
region | string | Нет | PostHog cloud region: us or eu (default: us) |
| Параметр | Тип | Описание |
|---|
survey | object | Survey details |
↳ id | string | Survey ID |
↳ name | string | Survey name |
↳ description | string | Survey description |
↳ type | string | Survey type (popover or api) |
↳ questions | array | Survey questions |
↳ appearance | object | Survey appearance configuration |
↳ conditions | object | Survey display conditions |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ start_date | string | Survey start date |
↳ end_date | string | Survey end date |
↳ archived | boolean | Whether survey is archived |
↳ responses_limit | number | Maximum number of responses |
Создать новый survey in PostHog. Supports question types: Basic (open), Link, Rating, и Multiple Choice.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: us or eu (default: us) |
name | string | Нет | Survey name (optional) |
description | string | Нет | Survey description |
type | string | Нет | Survey type: popover (in-app) or api (custom implementation) (default: popover) |
questions | string | Да | JSON string of survey questions array. Each question must have type (open/link/rating/multiple_choice) and question text. Rating questions can have scale (1-10), lowerBoundLabel, upperBoundLabel. Multiple choice questions need choices array. Link questions can have buttonText. |
startDate | string | Нет | Survey start date in ISO 8601 format |
endDate | string | Нет | Survey end date in ISO 8601 format |
appearance | string | Нет | JSON string of appearance configuration (colors, position, etc.) |
conditions | string | Нет | JSON string of display conditions (URL matching, etc.) |
targetingFlagFilters | string | Нет | JSON string of feature flag filters for targeting |
linkedFlagId | string | Нет | Feature flag ID to link to this survey |
responsesLimit | number | Нет | Maximum number of responses to collect |
| Параметр | Тип | Описание |
|---|
survey | object | Created survey details |
↳ id | string | Survey ID |
↳ name | string | Survey name |
↳ description | string | Survey description |
↳ type | string | Survey type (popover or api) |
↳ questions | array | Survey questions |
↳ created_at | string | Creation timestamp |
↳ start_date | string | Survey start date |
↳ end_date | string | Survey end date |
Обновитьn existing survey in PostHog. Can modify questions, appearance, conditions, и other settings.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
surveyId | string | Да | Survey ID to update (e.g., "01234567-89ab-cdef-0123-456789abcdef") |
region | string | Нет | PostHog cloud region: us or eu (default: us) |
name | string | Нет | Survey name |
description | string | Нет | Survey description |
type | string | Нет | Survey type: popover or api |
questions | string | Нет | JSON string of survey questions array. Each question must have type (open/link/rating/multiple_choice) and question text. |
startDate | string | Нет | Survey start date in ISO 8601 format |
endDate | string | Нет | Survey end date in ISO 8601 format |
appearance | string | Нет | JSON string of appearance configuration (colors, position, etc.) |
conditions | string | Нет | JSON string of display conditions (URL matching, etc.) |
targetingFlagFilters | string | Нет | JSON string of feature flag filters for targeting |
linkedFlagId | string | Нет | Feature flag ID to link to this survey |
responsesLimit | number | Нет | Maximum number of responses to collect |
archived | boolean | Нет | Archive or unarchive the survey |
| Параметр | Тип | Описание |
|---|
survey | object | Updated survey details |
↳ id | string | Survey ID |
↳ name | string | Survey name |
↳ description | string | Survey description |
↳ type | string | Survey type (popover or api) |
↳ questions | array | Survey questions |
↳ created_at | string | Creation timestamp |
↳ start_date | string | Survey start date |
↳ end_date | string | Survey end date |
↳ archived | boolean | Whether survey is archived |
Список session recordings in a PostHog project. Session recordings capture user interactions с your application.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: us or eu (default: us) |
limit | number | Нет | Количество результатов для возврата (default: 50, e.g., 10, 25, 50) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 50, 100) |
| Параметр | Тип | Описание |
|---|
recordings | array | List of session recordings |
↳ id | string | Recording ID |
↳ distinct_id | string | User distinct ID |
↳ viewed | boolean | Whether recording has been viewed |
↳ recording_duration | number | Recording duration in seconds |
↳ active_seconds | number | Active time in seconds |
↳ inactive_seconds | number | Inactive time in seconds |
↳ start_time | string | Recording start timestamp |
↳ end_time | string | Recording end timestamp |
↳ click_count | number | Number of clicks |
↳ keypress_count | number | Number of keypresses |
↳ console_log_count | number | Number of console logs |
↳ console_warn_count | number | Number of console warnings |
↳ console_error_count | number | Number of console errors |
↳ person | object | Person information |
count | number | Total number of recordings |
next | string | URL for next page of results |
previous | string | URL for previous page of results |
Получить details of a specific session recording in PostHog от ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
recordingId | string | Да | Session recording ID to retrieve (e.g., "01234567-89ab-cdef-0123-456789abcdef") |
region | string | Нет | PostHog cloud region: us or eu (default: us) |
| Параметр | Тип | Описание |
|---|
recording | object | Session recording details |
↳ id | string | Recording ID |
↳ distinct_id | string | User distinct ID |
↳ viewed | boolean | Whether recording has been viewed |
↳ recording_duration | number | Recording duration in seconds |
↳ active_seconds | number | Active time in seconds |
↳ inactive_seconds | number | Inactive time in seconds |
↳ start_time | string | Recording start timestamp |
↳ end_time | string | Recording end timestamp |
↳ click_count | number | Number of clicks |
↳ keypress_count | number | Number of keypresses |
↳ console_log_count | number | Number of console logs |
↳ console_warn_count | number | Number of console warnings |
↳ console_error_count | number | Number of console errors |
↳ start_url | string | Starting URL of the recording |
↳ person | object | Person information |
↳ matching_events | array | Events that occurred during recording |
Список session recording playlists in a PostHog project. Playlists allow you to organize и curate session recordings.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
region | string | Нет | PostHog cloud region: us or eu (default: us) |
limit | number | Нет | Количество результатов для возврата (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | Количество результатов для пропуска for постраничная выборка (e.g., 0, 100, 200) |
| Параметр | Тип | Описание |
|---|
playlists | array | List of session recording playlists |
↳ id | string | Playlist ID |
↳ short_id | string | Playlist short ID |
↳ name | string | Playlist name |
↳ description | string | Playlist description |
↳ created_at | string | Creation timestamp |
↳ created_by | object | Creator information |
↳ deleted | boolean | Whether playlist is deleted |
↳ filters | object | Playlist filters |
↳ last_modified_at | string | Last modification timestamp |
↳ last_modified_by | object | Last modifier information |
↳ derived_name | string | Auto-generated name from filters |
count | number | Total number of playlists |
next | string | URL for next page of results |
previous | string | URL for previous page of results |
Список всех event definitions in a PostHog project. Event definitions represent tracked events с metadata like descriptions, tags, и usage statistics.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
limit | number | Нет | Количество результатов для возврата per page (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | The initial index from which to return results (e.g., 0, 100, 200) |
search | string | Нет | Search term to filter event definitions by name |
| Параметр | Тип | Описание |
|---|
count | number | Total number of event definitions |
next | string | URL for the next page of results |
previous | string | URL for the previous page of results |
results | array | List of event definitions |
↳ id | string | Unique identifier for the event definition |
↳ name | string | Event name |
↳ description | string | Event description |
↳ tags | array | Tags associated С помощью event |
↳ volume_30_day | number | Number of events received in the last 30 days |
↳ query_usage_30_day | number | Number of times this event was queried in the last 30 days |
↳ created_at | string | ISO timestamp when the event was created |
↳ last_seen_at | string | ISO timestamp when the event was last seen |
↳ updated_at | string | ISO timestamp when the event was updated |
↳ updated_by | object | User who last updated the event |
Получить details of a specific event definition in PostHog. Returns comprehensive information about the event including metadata, usage statistics, и verification status.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
eventDefinitionId | string | Да | Event Definition ID to retrieve |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
| Параметр | Тип | Описание |
|---|
id | string | Unique identifier for the event definition |
name | string | Event name |
description | string | Event description |
tags | array | Tags associated С помощью event |
volume_30_day | number | Number of events received in the last 30 days |
query_usage_30_day | number | Number of times this event was queried in the last 30 days |
created_at | string | ISO timestamp when the event was created |
last_seen_at | string | ISO timestamp when the event was last seen |
updated_at | string | ISO timestamp when the event was updated |
updated_by | object | User who last updated the event |
verified | boolean | Произошла ли event has been verified |
verified_at | string | ISO timestamp when the event was verified |
verified_by | string | User who verified the event |
Обновитьn event definition in PostHog. Can modify description, tags, и verification status to maintain clean event schemas.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
eventDefinitionId | string | Да | Event Definition ID to update |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
description | string | Нет | Updated description for the event |
tags | string | Нет | Comma-separated list of tags to associate С помощью event |
verified | boolean | Нет | Whether to mark the event as verified |
| Параметр | Тип | Описание |
|---|
id | string | Unique identifier for the event definition |
name | string | Event name |
description | string | Updated event description |
tags | array | Updated tags associated С помощью event |
volume_30_day | number | Number of events received in the last 30 days |
query_usage_30_day | number | Number of times this event was queried in the last 30 days |
created_at | string | ISO timestamp when the event was created |
last_seen_at | string | ISO timestamp when the event was last seen |
updated_at | string | ISO timestamp when the event was updated |
updated_by | object | User who last updated the event |
verified | boolean | Произошла ли event has been verified |
verified_at | string | ISO timestamp when the event was verified |
verified_by | string | User who verified the event |
Список всех property definitions in a PostHog project. Property definitions represent tracked properties с metadata like descriptions, tags, types, и usage statistics.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
limit | number | Нет | Количество результатов для возврата per page (default: 100, e.g., 10, 50, 100) |
offset | number | Нет | The initial index from which to return results (e.g., 0, 100, 200) |
search | string | Нет | Search term to filter property definitions by name |
type | string | Нет | Filter by property type: event, person, or group |
| Параметр | Тип | Описание |
|---|
count | number | Total number of property definitions |
next | string | URL for the next page of results |
previous | string | URL for the previous page of results |
results | array | List of property definitions |
↳ id | string | Unique identifier for the property definition |
↳ name | string | Property name |
↳ description | string | Property description |
↳ tags | array | Tags associated С помощью property |
↳ is_numerical | boolean | Произошла ли property is numerical |
↳ is_seen_on_filtered_events | boolean | Произошла ли property is seen on filtered events |
↳ property_type | string | The data type of the property |
↳ type | string | Property type: event, person, or group |
↳ volume_30_day | number | Number of times property was seen in the last 30 days |
↳ query_usage_30_day | number | Number of times this property was queried in the last 30 days |
↳ created_at | string | ISO timestamp when the property was created |
↳ updated_at | string | ISO timestamp when the property was updated |
↳ updated_by | object | User who last updated the property |
Получить details of a specific property definition in PostHog. Returns comprehensive information about the property including metadata, type, usage statistics, и verification status.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
propertyDefinitionId | string | Да | Property Definition ID to retrieve |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
| Параметр | Тип | Описание |
|---|
id | string | Unique identifier for the property definition |
name | string | Property name |
description | string | Property description |
tags | array | Tags associated С помощью property |
is_numerical | boolean | Произошла ли property is numerical |
is_seen_on_filtered_events | boolean | Произошла ли property is seen on filtered events |
property_type | string | The data type of the property |
type | string | Property type: event, person, or group |
volume_30_day | number | Number of times property was seen in the last 30 days |
query_usage_30_day | number | Number of times this property was queried in the last 30 days |
created_at | string | ISO timestamp when the property was created |
updated_at | string | ISO timestamp when the property was updated |
updated_by | object | User who last updated the property |
verified | boolean | Произошла ли property has been verified |
verified_at | string | ISO timestamp when the property was verified |
verified_by | string | User who verified the property |
example | string | Example value for the property |
Обновить property definition in PostHog. Can modify description, tags, property type, и verification status to maintain clean property schemas.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | PostHog Project ID (e.g., "12345" or project UUID) |
propertyDefinitionId | string | Да | Property Definition ID to update |
region | string | Да | PostHog cloud region: us or eu |
apiKey | string | Да | PostHog Personal API Key |
description | string | Нет | Updated description for the property |
tags | string | Нет | Comma-separated list of tags to associate С помощью property |
verified | boolean | Нет | Whether to mark the property as verified |
property_type | string | Нет | data type of the property (e.g., String, Numeric, Boolean, DateTime, etc.) |
| Параметр | Тип | Описание |
|---|
id | string | Unique identifier for the property definition |
name | string | Property name |
description | string | Updated property description |
tags | array | Updated tags associated С помощью property |
is_numerical | boolean | Произошла ли property is numerical |
is_seen_on_filtered_events | boolean | Произошла ли property is seen on filtered events |
property_type | string | The data type of the property |
type | string | Property type: event, person, or group |
volume_30_day | number | Number of times property was seen in the last 30 days |
query_usage_30_day | number | Number of times this property was queried in the last 30 days |
created_at | string | ISO timestamp when the property was created |
updated_at | string | ISO timestamp when the property was updated |
updated_by | object | User who last updated the property |
verified | boolean | Произошла ли property has been verified |
verified_at | string | ISO timestamp when the property was verified |
verified_by | string | User who verified the property |
example | string | Example value for the property |
Список всех projects in the organization. Returns project details including IDs, names, API tokens, и settings. Useful для getting project IDs needed by other endpoints.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
region | string | Нет | Cloud region: us or eu (default: us) |
| Параметр | Тип | Описание |
|---|
projects | array | List of projects С помощьюir configuration and settings |
↳ id | number | Project ID |
↳ uuid | string | Project UUID |
↳ organization | string | Organization UUID |
↳ api_token | string | Project API token for ingestion |
↳ app_urls | array | Allowed app URLs |
↳ name | string | Project name |
↳ slack_incoming_webhook | string | Slack webhook URL for notifications |
↳ created_at | string | Project creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ anonymize_ips | boolean | Whether IP anonymization is enabled |
↳ completed_snippet_onboarding | boolean | Whether snippet onboarding is completed |
↳ ingested_event | boolean | Whether any event has been ingested |
↳ test_account_filters | array | Filters for test accounts |
↳ is_demo | boolean | Произошла ли эта is a demo project |
↳ timezone | string | Project timezone |
↳ data_attributes | array | Custom data attributes |
Получить подробную информацию about a specific project от ID. Returns comprehensive project configuration, settings, и feature flags.
| Параметр | Тип | Обязательный | Описание |
|---|
projectId | string | Да | Project ID (e.g., "12345" or project UUID) |
apiKey | string | Да | PostHog Personal API Key |
region | string | Нет | Cloud region: us or eu (default: us) |
| Параметр | Тип | Описание |
|---|
project | object | Detailed project information with all configuration settings |
↳ id | number | Project ID |
↳ uuid | string | Project UUID |
↳ organization | string | Organization UUID |
↳ api_token | string | Project API token for ingestion |
↳ app_urls | array | Allowed app URLs |
↳ name | string | Project name |
↳ slack_incoming_webhook | string | Slack webhook URL for notifications |
↳ created_at | string | Project creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ anonymize_ips | boolean | Whether IP anonymization is enabled |
↳ completed_snippet_onboarding | boolean | Whether snippet onboarding is completed |
↳ ingested_event | boolean | Whether any event has been ingested |
↳ test_account_filters | array | Filters for test accounts |
↳ is_demo | boolean | Произошла ли эта is a demo project |
↳ timezone | string | Project timezone |
↳ data_attributes | array | Custom data attributes |
↳ person_display_name_properties | array | Properties used for person display names |
↳ correlation_config | object | Configuration for correlation analysis |
↳ autocapture_opt_out | boolean | Whether autocapture is disabled |
↳ autocapture_exceptions_opt_in | boolean | Whether exception autocapture is enabled |
↳ session_recording_opt_in | boolean | Whether session recording is enabled |
↳ capture_console_log_opt_in | boolean | Whether console log capture is enabled |
↳ capture_performance_opt_in | boolean | Whether performance capture is enabled |
Список всех organizations the user has access to. Returns organization details including name, slug, membership level, и available product features.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | PostHog Personal API Key |
region | string | Нет | Cloud region: us or eu (default: us) |
| Параметр | Тип | Описание |
|---|
organizations | array | List of organizations С помощьюir settings and features |
↳ id | string | Organization ID (UUID) |
↳ name | string | Organization name |
↳ slug | string | Organization slug |
↳ created_at | string | Organization creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ membership_level | number | User membership level in organization |
↳ plugins_access_level | number | Access level for plugins/apps |
↳ teams | array | List of team IDs in this organization |
↳ available_product_features | array | Available product features and their limits |
Получить подробную информацию about a specific organization от ID. Returns comprehensive organization settings, features, usage, и team information.
| Параметр | Тип | Обязательный | Описание |
|---|
organizationId | string | Да | Organization ID (e.g., "01234567-89ab-cdef-0123-456789abcdef") |
apiKey | string | Да | PostHog Personal API Key |
region | string | Нет | Cloud region: us or eu (default: us) |
| Параметр | Тип | Описание |
|---|
organization | object | Detailed organization information with settings and features |
↳ id | string | Organization ID (UUID) |
↳ name | string | Organization name |
↳ slug | string | Organization slug |
↳ created_at | string | Organization creation timestamp |
↳ updated_at | string | Last update timestamp |
↳ membership_level | number | User membership level in organization |
↳ plugins_access_level | number | Access level for plugins/apps |
↳ teams | array | List of team IDs in this organization |
↳ available_product_features | array | Available product features С помощьюir limits and descriptions |
↳ domain_whitelist | array | Whitelisted domains for organization |
↳ is_member_join_email_enabled | boolean | Whether member join emails are enabled |
↳ metadata | object | Organization metadata |
↳ customer_id | string | Customer ID for billing |
↳ available_features | array | List of available feature flags for organization |
↳ usage | object | Organization usage statistics |
