# PostHog

PostHog is an open-source product analytics platform tracking user interactions and behaviors to help teams refine features, improve funnels, and reduce churn

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 506
- **Triggers:** 0
- **Slug:** `POSTHOG`
- **Version:** 20260316_00

## Frequently Asked Questions

### How do I set up custom OAuth credentials for PostHog?

For a step-by-step guide on creating and configuring your own PostHog OAuth credentials with Composio, see [How to create OAuth credentials for PostHog](https://composio.dev/auth/posthog).

## Tools

### Add dashboard collaborators with access level

**Slug:** `POSTHOG_ADD_DASHBOARD_COLLABORATORS_WITH_ACCESS_LEVEL`

Add collaborators to a specific project dashboard. Requires 'project_id' and 'dashboard_id'. Supports JSON, form-urlencoded, and multipart data. Returns added collaborator details. Auth: 'PersonalAPIKeyAuth'. IMPORTANT REQUIREMENTS: 1. The dashboard must have restriction_level > 21 (not on the lowest restriction level). Use POSTHOG_PARTIAL_UPDATE_OF_A_PROJECT_S_DASHBOARD to set restriction_level to 37. 2. The user being added cannot be the dashboard owner or a project admin (they already have inherent access). 3. Currently only level 37 (edit access) can be explicitly specified. 4. Use POSTHOG_LIST_ORGANIZATION_MEMBERS_WITH_PAGINATION to find valid user UUIDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `level` | integer | Yes | Access level for the collaborator. Currently only level 37 (can edit) is supported by the API. View-only access (21) cannot be explicitly specified. |
| `user_uuid` | string | Yes | User UUID - the unique identifier of the user to add as a collaborator |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `dashboard_id` | integer | Yes | Dashboard Id - the unique identifier of the dashboard to add a collaborator to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add member to organization role

**Slug:** `POSTHOG_ADD_MEMBER_TO_ORGANIZATION_ROLE`

Add a member to an organization role by submitting their details and UUID in JSON/form, using organization and role IDs. Requires PersonalAPIKeyAuth. Success gives a 201 status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Role Id (UUID) |
| `user_uuid` | string | Yes | User UUID to add to the role |
| `organization_id` | string | Yes | Organization Id (UUID) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add persons to static cohort

**Slug:** `POSTHOG_ADD_PERSONS_TO_STATIC_COHORT`

Add persons to a static cohort by their UUIDs. Use when you need to manually add specific users to a static cohort. Only works with static cohorts (is_static=true), not dynamic cohorts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this cohort. |
| `person_ids` | array | Yes | List of person UUIDs to add to the static cohort. Each UUID must be a valid person identifier in the project. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add product intent to project

**Slug:** `POSTHOG_ADD_PRODUCT_INTENT_TO_PROJECT`

Tool to add a product intent to a PostHog project. Use when you need to register a project's intention to use a specific PostHog product feature. Product intents help track which features (product analytics, feature flags, data warehouse, experiments, surveys) a project plans to use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this project |
| `product_type` | string ("product_analytics" | "feature_flags" | "data_warehouse" | "experiments" | "surveys") | Yes | The product type to add intent for. Indicates which PostHog product feature the project intends to use |
| `organization_id` | string | Yes | Organization ID (UUID) that owns the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add project specific member roles

**Slug:** `POSTHOG_ADD_PROJECT_SPECIFIC_MEMBER_ROLES`

Add members with specific roles to a project by providing their user_uuid and level (member or admin). Requires project_id in the URL. Supports JSON, form-data, and form-urlencoded input. Returns the newly created membership data upon success. Note: This endpoint only works for projects with access control enabled (private projects). If the project does not have access control enabled, the API will return a 404 "Endpoint not found" error. Access control is an Enterprise feature that can be enabled in Project Settings > Access Control.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `level` | integer | No | The access level for the user. Common values: 1 (member), 8 (admin). |
| `user_uuid` | string | Yes | The UUID of the user to add as an explicit member of the project. |
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE and look at the 'teams' or 'projects' array. IMPORTANT: This endpoint only works for projects with access_control enabled (private projects). Check the 'access_control' field in the team/project data - if it's false, this endpoint will return 404. Access control is an Enterprise feature enabled in Project Settings > Access Control. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add session recording to playlist

**Slug:** `POSTHOG_ADD_SESSION_RECORDING_TO_PLAYLIST`

Add an existing session recording to a playlist. This endpoint associates a specific session recording with a playlist, making it part of that collection. Requires 'project_id' (project identifier), 'short_id' (playlist identifier), and 'session_recording_id' (recording identifier) in the URL. Optional body parameters can be used to update playlist properties. Works with both 'collection' and 'filters' type playlists. Returns the updated playlist details on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Playlist ID (optional, read-only - automatically assigned by the server) |
| `name` | string | No | Optional name for the playlist (can be used to update the playlist name when adding the recording) |
| `pinned` | boolean | No | Optional boolean to pin the playlist to the top of the list (defaults to false) |
| `deleted` | boolean | No | Optional boolean flag to mark the playlist as deleted (soft delete) |
| `filters` | string | No | Optional filter criteria for 'filters' type playlists. Can include events, duration, filter_group, date ranges, etc. Not typically used when adding recordings to 'collection' type playlists. |
| `short_id` | string | Yes | The short identifier (short_id) of the playlist to which the recording will be added. Obtain this from creating or listing session recording playlists. |
| `created_at` | string | No | Playlist creation timestamp (optional, read-only - automatically set by the server) |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `short_id_1` | string | No | Playlist short identifier in the request body (optional, typically not needed as it's already in the URL path) |
| `description` | string | No | Optional description for the playlist (can be used to update the playlist description when adding the recording) |
| `derived_name` | string | No | Optional derived name for the playlist (auto-generated by PostHog if not provided) |
| `last_modified_at` | string | No | Timestamp of the last modification (optional, read-only - automatically updated by the server) |
| `session_recording_id` | string | Yes | The unique identifier of the session recording to add to the playlist. This is the ID of an existing session recording in the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Append Desktop Recording Segments

**Slug:** `POSTHOG_APPEND_DESKTOP_RECORDING_SEGMENTS`

Append transcript segments to an existing desktop recording for real-time streaming support. Use when you need to add new transcript segments to a recording in batches as they become available from transcription services like AssemblyAI. Requires desktop_recording:write scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the desktop recording to append segments to |
| `segments` | array | Yes | List of transcript segments to append (minimum 1 segment required). Supports batched real-time streaming. |
| `project_id` | string | Yes | Project ID (environment ID) containing the recording. Find it via /api/projects/ |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive survey response

**Slug:** `POSTHOG_ARCHIVE_SURVEY_RESPONSE`

Tool to archive a single survey response. Use when you need to hide a survey response from analytics while preserving it in the database.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `response_uuid` | string | Yes | UUID string identifying the survey response to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign feature flag role based access

**Slug:** `POSTHOG_ASSIGN_FEATURE_FLAG_ROLE_BASED_ACCESS`

Set up role-based access for a feature flag using `project_id` and `feature_flag_id`. Submit access info in JSON or form format, with `feature_flag:write` rights. Success returns new details with a 201 code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Role Id (UUID format) |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `feature_flag_id` | integer | Yes | Feature Flag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk create organization invites

**Slug:** `POSTHOG_BULK_CREATE_ORGANIZATION_INVITES`

POST /api/organizations/{organization_id}/invites/bulk/: Bulk-create organization invites with customizable levels, sender details, and validation checks. Supports email automation and private project access settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invites` | array | Yes | List of invites to create |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk delete feature flags

**Slug:** `POSTHOG_BULK_DELETE_FEATURE_FLAGS`

Bulk delete feature flags by filter criteria or explicit IDs. Use when you need to delete multiple feature flags at once. Accepts either 'filters' (same filter params as list endpoint: search, active, type, etc.) or 'ids' (explicit list of flag IDs). Returns operation status and count of deleted flags. Use '@current' as project_id for the current project context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Explicit list of feature flag IDs to delete. No limit on the number of IDs. Use this to delete specific flags by their numeric IDs. Mutually exclusive with 'filters'. |
| `filters` | object | No | Filter criteria to select feature flags for deletion. Supports the same filter parameters as the list endpoint: 'search' (keyword search), 'active' (boolean), 'type' (flag type), etc. Use this to delete flags matching specific conditions. Mutually exclusive with 'ids'. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. Use '@current' for the current project or provide the numeric project ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Persons Bulk Delete

**Slug:** `POSTHOG_BULK_DELETE_PERSONS`

Tool to bulk delete persons by PostHog person IDs or distinct IDs. Use when you need to delete multiple persons at once (up to 100 per call). Only events captured before the request will be deleted. Deletion is asynchronous and batched at 5AM UTC every Sunday.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | A list of PostHog person UUIDs, up to 100 of them. Either ids or distinct_ids is required. |
| `format` | string ("csv" | "json") | No | Response format (csv or json) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `keep_person` | boolean | No | If true, the person record itself will not be deleted. This is useful if you want to keep the person record for auditing purposes but remove events and recordings associated with them |
| `distinct_ids` | array | No | A list of distinct IDs, up to 100 of them. Either ids or distinct_ids is required. |
| `delete_events` | boolean | No | If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday |
| `delete_recordings` | boolean | No | If true, a task to delete all recordings associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel insights for a project

**Slug:** `POSTHOG_CANCEL_PROJECT_INSIGHTS`

The "/api/projects/{project_id}/insights/cancel/" endpoint allows users to cancel insights for a project by providing a project ID and insight details in JSON or CSV, and confirms cancellation in the response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Insight ID |
| `name` | string | No | Name |
| `tags` | array | No | Tags |
| `hogql` | string | No | Hogql |
| `order` | integer | No | Order |
| `query` | string | No | Query node JSON string |
| `saved` | boolean | No | Saved |
| `types` | string | No | Types |
| `format` | string ("csv" | "json") | No | Response format (json or csv) |
| `result` | string | No | Result |
| `columns` | string | No | Columns |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `short_id` | string | No | Short Id of the insight |
| `timezone` | string | No | The timezone this chart is displayed in. |
| `favorited` | boolean | No | Favorited |
| `is_cached` | string | No | Is Cached |
| `is_sample` | boolean | No | Is Sample |
| `created_at` | string | No | Created At |
| `dashboards` | array | No | DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on. |
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | Updated At |
| `description` | string | No | Description |
| `derived_name` | string | No | Derived Name |
| `last_refresh` | string | No | The datetime this insight results were generated. If added to one or more dashboards the insight can be refreshed separately on each. |
| `query_status` | string | No | Query Status |
| `client_query_id` | string | No | The client query ID of the running query to cancel |
| `dashboard_tiles` | array | No | A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on. |
| `cache_target_age` | string | No | The target age of the cached results for this insight. |
| `last_modified_at` | string | No | Last Modified At |
| `next_allowed_client_refresh` | string | No | The earliest possible datetime at which the cached results for this insight can be refreshed by querying the database. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Capture Event

**Slug:** `POSTHOG_CAPTURE_EVENT`

Capture (ingest) a single analytics event into PostHog using the public ingestion API and a project API key. Use when you need to send custom events like 'lesson_started', 'quiz_completed', or any user behavior tracking. This bypasses the private /api/* endpoints and uses PostHog's public write-only ingestion endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event` | string | Yes | Name of the event to capture (e.g., 'lesson_started', 'quiz_completed', 'button_clicked') |
| `api_key` | string | Yes | Project API Key (write-only ingestion key). This is different from your personal API key and is safe to use in public contexts. |
| `timestamp` | string | No | ISO 8601 timestamp indicating when the event occurred (e.g., '2024-05-22T17:09:29.220Z'). If not provided, PostHog uses the current server time. |
| `properties` | object | No | Optional event properties containing arbitrary metadata about the event (e.g., {'lesson_id': '42', 'score': 95}) |
| `distinct_id` | string | Yes | Unique identifier for the user or entity. Commonly a UUID or user ID (e.g., '018daf23-89b3-7cf8-a4f1-94064c96df90' or 'user_123') |
| `ingest_host` | string | No | PostHog ingestion host. Use 'https://us.i.posthog.com' for US Cloud, 'https://eu.i.posthog.com' for EU Cloud, or your self-hosted domain. Defaults to US Cloud. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check pipeline destination updates

**Slug:** `POSTHOG_CHECK_PIPELINE_DESTINATION_UPDATES`

Check for available updates to a pipeline destination plugin by comparing the currently installed version (tag) with the latest version available in the plugin's repository. Use this to determine if a pipeline destination plugin can be upgraded to a newer version. Returns update information including current tag, latest tag, and whether an update is available. Note: This endpoint may require admin/staff permissions or may only be available for custom organization-owned plugins (not global PostHog Inc. plugins).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Pipeline destination plugin ID to check for updates (obtained from list pipeline destinations) |
| `organization_id` | string | Yes | Organization ID (UUID format) that owns or has access to the pipeline destination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check pipeline import app updates

**Slug:** `POSTHOG_CHECK_PIPELINE_IMPORT_APP_UPDATES`

Retrieve the latest update information for a specific pipeline import app by its ID within an organization. This endpoint returns details such as plugin type, name, description, and version data. Requires 'id' and 'organization_id' as path parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check pipeline plugin update status

**Slug:** `POSTHOG_CHECK_PIPELINE_PLUGIN_UPDATE_STATUS`

Get update status for a specific pipeline transformation plugin by its unique ID within an organization. This endpoint requires the 'organization_id' and 'plugin' IDs and returns details like plugin type, name, and update information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check project's demo data generation status

**Slug:** `POSTHOG_CHECK_PROJECT_DEMO_DATA_GENERATION_STATUS`

Check if a project is currently generating demo data. This endpoint retrieves the demo data generation status for a specific project within an organization. Returns whether the project is currently in the process of generating demo data. **Important Authentication Note**: This endpoint requires session-based authentication (cookie-based) and does not support Personal API Key authentication. It may return 403 Forbidden when using API keys. This endpoint is primarily intended for use within the PostHog web application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this team (soon to be environment). |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Max AI insight and query

**Slug:** `POSTHOG_CREATE_AI_INSIGHT`

Tool to create and query insights using PostHog's Max AI assistant. Use when you need to generate insights from natural language queries. The AI interprets your query and creates the appropriate insight configuration (trends, funnels, or retention). Returns the generated insight with query configuration and results data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Natural language query describing the insight to create (e.g., 'Show me page views for the last 7 days', 'What are the top events by count?') |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `insight_type` | string ("trends" | "funnels" | "retention") | Yes | Type of insight to create: 'trends' for time-series analysis, 'funnels' for conversion analysis, 'retention' for cohort retention analysis |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create alert

**Slug:** `POSTHOG_CREATE_ALERT`

Tool to create a new alert configuration in PostHog. Use when you need to set up monitoring for insights with specific thresholds and notification settings. The alert will monitor the specified insight and notify subscribed users when threshold conditions are met.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Alert name. Maximum 255 characters. |
| `config` | object | No | Alert configuration settings |
| `enabled` | boolean | Yes | Whether the alert is enabled immediately upon creation |
| `insight` | integer | Yes | Insight ID monitored by this alert. The insight must exist in the same project. |
| `condition` | object | No | Alert condition configuration |
| `threshold` | object | Yes | Alert threshold configuration defining when alert triggers |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `skip_weekend` | boolean | No | Whether to skip checks during weekends |
| `snoozed_until` | string | No | ISO 8601 timestamp until which the alert is snoozed |
| `subscribed_users` | array | Yes | List of user IDs to subscribe to this alert. Can be an empty list if no users should be subscribed initially. |
| `calculation_interval` | string | No | Calculation interval for the alert (can be string or object) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Batch

**Slug:** `POSTHOG_CREATE_BATCH`

Capture a batch of analytics events to PostHog using the public batch ingestion API. Use when you need to send multiple events efficiently in a single request (e.g., bulk event imports, offline event syncing).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch` | array | Yes | Array of event objects to capture. Each event must include 'event' name and 'properties' dict with 'distinct_id'. Total payload should be under 20MB. |
| `api_key` | string | Yes | Project API Key (write-only ingestion key). This is different from your personal API key and is safe to use in public contexts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create batch export

**Slug:** `POSTHOG_CREATE_BATCH_EXPORT`

Create a new batch export to automatically export PostHog data to external destinations like S3, BigQuery, or Snowflake. Use when you need to set up scheduled data exports with configurable intervals and destination-specific settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for this batch export |
| `model` | string ("events" | "persons" | "sessions") | No | Data models available for batch export |
| `end_at` | string | No | ISO 8601 timestamp for when exports should stop (e.g., '2024-12-31T23:59:59Z'). Exports won't run after this time |
| `paused` | boolean | No | Whether to create the batch export in a paused state (defaults to false) |
| `schema` | object | No | Custom schema configuration defining which fields to export |
| `filters` | object | No | Filter configuration to specify which data to export |
| `interval` | string ("hour" | "day" | "week" | "every 5 minutes") | Yes | How frequently the batch export should run |
| `start_at` | string | No | ISO 8601 timestamp for when exports should start (e.g., '2024-01-01T00:00:00Z'). Exports won't run before this time |
| `timezone` | string | No | Timezone for scheduling exports (e.g., 'America/New_York', 'UTC') |
| `offset_day` | integer | No | Day offset for weekly exports (0=Sunday, 6=Saturday) |
| `project_id` | string | Yes | Project ID (also called environment ID in some contexts) where the batch export will be created. Find this via /api/projects/ |
| `destination` | object | Yes | Configuration specifying where and how data should be exported |
| `hogql_query` | string | No | Optional HogQL query to filter or transform the exported data |
| `offset_hour` | integer | No | Hour offset for scheduling exports (0-23) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create batch exports backfills

**Slug:** `POSTHOG_CREATE_BATCH_EXPORT_BACKFILL`

Tool to create a new backfill for a BatchExport. Use when you need to re-export historical data for a specific time range. Requires valid start_at and end_at timestamps in ISO 8601 format. The end_at timestamp cannot be in the future.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_at` | string | Yes | The end of the data interval for the backfill. Must be in ISO 8601 format (e.g., '2026-02-16T10:00:00Z') and cannot be in the future. |
| `start_at` | string | Yes | The start of the data interval for the backfill. Must be in ISO 8601 format (e.g., '2026-02-16T09:00:00Z') and within valid data range. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `batch_export_id` | string | Yes | The BatchExport this backfill belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create batch exports run test step

**Slug:** `POSTHOG_CREATE_BATCH_EXPORT_TEST_RUN`

Tool to run a test step for a batch export configuration in PostHog. Use when you need to validate that a batch export is properly configured before enabling it. This endpoint triggers a test run to verify the destination connectivity and configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this batch export |
| `name` | string | Yes | A human-readable name for this batch export |
| `model` | string | No | Which model this batch export is exporting (e.g., events, persons, sessions) |
| `end_at` | string | No | ISO 8601 timestamp after which any batch export runs won't be triggered |
| `paused` | boolean | Yes | Whether this batch export is currently paused |
| `schema` | object | No | A schema of custom fields to select when exporting data |
| `filters` | object | No | Optional filter configuration to specify which data to export |
| `team_id` | integer | Yes | The team ID this batch export belongs to |
| `interval` | string ("hour" | "day" | "week" | "every 5 minutes") | Yes | Export frequency/interval (hour, day, week, or every 5 minutes) |
| `start_at` | string | No | ISO 8601 timestamp before which any batch export runs won't be triggered |
| `timezone` | string | No | Optional timezone configuration for the batch export |
| `created_at` | string | Yes | ISO 8601 timestamp when the batch export was created |
| `offset_day` | integer | No | Day offset (0-6) for scheduling batch export runs |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |
| `destination` | object | Yes | Configuration for where data is exported, including type and destination-specific settings |
| `hogql_query` | string | No | Optional HogQL query string for filtering or transforming exported data |
| `latest_runs` | array | Yes | Array of recent batch export run information |
| `offset_hour` | integer | No | Hour offset (0-23) for scheduling batch export runs |
| `last_paused_at` | string | No | ISO 8601 timestamp when the batch export was last paused |
| `last_updated_at` | string | Yes | ISO 8601 timestamp of the last update to the batch export |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create customer profile config

**Slug:** `POSTHOG_CREATE_CUSTOMER_PROFILE_CONFIG`

Create a customer profile configuration for a PostHog project. Use when you need to configure how customer profiles are displayed and organized for persons or groups within a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4") | Yes | The scope of the customer profile configuration. Can be 'person' for individual profiles or 'group_0' through 'group_4' for group profiles. |
| `content` | object | No | Configuration content for the customer profile. Optional field that can contain custom profile configuration data. |
| `sidebar` | object | No | Sidebar configuration for the customer profile view. Optional field for customizing sidebar display. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project insights with customizable parameters

**Slug:** `POSTHOG_CREATE_CUSTOM_PROJECT_INSIGHTS`

Create custom analytics insights for a PostHog project. This action allows you to create various types of insights including trends, funnels, retention analysis, and more. Each insight is defined by a query object that specifies the type of analysis and the data to examine. Key Parameters: - project_id (required): The ID of the project to create the insight in - query (recommended): Query configuration object with 'kind' and 'source' defining the insight type - name: Display name for the insight - description: Detailed explanation of what the insight measures - saved: Whether to permanently save the insight (true) or keep it temporary (false) - tags: List of tags for organization - format: Response format ('json' or 'csv') Supported Query Types: - TrendsQuery: Track event trends over time - FunnelsQuery: Analyze conversion funnels - RetentionQuery: Measure user retention - And more (see PostHog documentation) Returns the created insight with ID, short_id, timestamps, and all configured properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Id (read-only, server-generated) |
| `name` | string | No | Display name for the insight. If not provided, the insight will have no name. |
| `tags` | array | No | List of tags for categorizing and organizing insights (e.g., ['conversion', 'signup']). |
| `hogql` | string | No | Hogql (read-only) |
| `order` | integer | No | Display order position for the insight when shown in lists or dashboards. |
| `query` | string | No | Query configuration object defining the insight type and data to analyze. Should be a dictionary with 'kind': 'InsightVizNode' and 'source' containing the query type (TrendsQuery, FunnelsQuery, RetentionQuery, etc.) and series/filters. |
| `saved` | boolean | No | Whether to save this insight permanently. Set to false for temporary/unsaved insights that won't appear in saved lists. |
| `types` | string | No | Types (read-only) |
| `format` | string ("csv" | "json") | No | Response format: 'json' returns structured JSON data, 'csv' returns CSV formatted data. Defaults to 'json'. |
| `result` | string | No | Result (read-only, server-generated) |
| `columns` | string | No | Columns (read-only) |
| `deleted` | boolean | No | Soft delete flag. Set to true to mark the insight as deleted without removing it from the database. |
| `filters` | string | No | Legacy filters object (deprecated). For new insights, use the 'query' parameter instead with InsightVizNode structure. |
| `short_id` | string | No | Short Id (read-only, server-generated) |
| `timezone` | string | No | Timezone for displaying time-based data in the insight (e.g., 'UTC', 'America/New_York'). If not specified, uses the project's default timezone. |
| `favorited` | boolean | No | Whether this insight is marked as a favorite for quick access. Set to true to favorite. |
| `is_cached` | string | No | Is Cached (read-only) |
| `is_sample` | boolean | No | Is Sample (read-only) |
| `created_at` | string | No | Created At (read-only, server-generated) |
| `dashboards` | array | No |          DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.         A dashboard ID for each of the dashboards that this insight is displayed on.           |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | Updated At (read-only, server-generated) |
| `description` | string | No | Detailed description of what this insight measures or analyzes. |
| `derived_name` | string | No | Automatically generated name based on the insight configuration. Typically read-only. |
| `last_refresh` | string | No |      The datetime this insight"s results were generated (read-only, server-generated).      |
| `query_status` | string | No | Query Status (read-only) |
| `dashboard_tiles` | array | No |      A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.       |
| `cache_target_age` | string | No | The target age of the cached results for this insight (read-only). |
| `last_modified_at` | string | No | Last Modified At (read-only, server-generated) |
| `next_allowed_client_refresh` | string | No |      The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed (read-only).       |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create data color theme

**Slug:** `POSTHOG_CREATE_DATA_COLOR_THEME`

Tool to create a new data color theme in a PostHog project. Use when you need to define custom color palettes for data visualization. Requires a theme name and list of hex color codes. Returns the created theme with auto-generated ID and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the data color theme (max 100 characters) |
| `colors` | array | Yes | List of hex color codes for the theme (e.g., ['#FF5733', '#33FF57', '#3357FF']) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dataset

**Slug:** `POSTHOG_CREATE_DATASET`

Tool to create a new dataset in a PostHog project. Use when you need to create a dataset for organizing data. Requires a project ID and a dataset name; description and metadata are optional.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Dataset name (required, max 400 characters) |
| `metadata` | object | No | Additional metadata for the dataset (optional) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Dataset description (optional) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dataset Items

**Slug:** `POSTHOG_CREATE_DATASET_ITEM`

Tool to create a new dataset item in a PostHog project dataset. Use when you need to add a new item with input/output data to a dataset for ML/AI experimentation or tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | object | No | Input data for the dataset item (e.g., prompt or question) |
| `output` | object | No | Output data for the dataset item (e.g., response or result) |
| `dataset` | string | Yes | UUID of the dataset to add this item to |
| `metadata` | object | No | Optional metadata associated with the dataset item |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `ref_trace_id` | string | No | Reference trace ID (max 255 characters) |
| `ref_source_id` | string | No | Reference source ID (max 255 characters) |
| `ref_timestamp` | string | No | Reference timestamp (ISO 8601 datetime format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create desktop recording

**Slug:** `POSTHOG_CREATE_DESKTOP_RECORDING`

Create a new desktop recording and get Recall.ai upload token for the desktop SDK. Use when you need to initiate a new recording session and obtain credentials for uploading audio/video data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("zoom" | "teams" | "meet" | "desktop_audio" | "slack") | No | Meeting platform being recorded (zoom, teams, meet, desktop_audio, or slack) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create endpoint

**Slug:** `POSTHOG_CREATE_ENDPOINT`

Tool to create a new endpoint for a PostHog project. Endpoints allow you to define and execute custom queries (HogQL, Trends, Funnels, etc.) that can be accessed via a URL-safe name. Use when you need to set up a new data query endpoint with specific query configuration and caching options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | URL-safe name for the endpoint. Must be alphanumeric with hyphens or underscores only (e.g., 'test-endpoint', 'my_endpoint_1'). |
| `query` | object | Yes | Query configuration for the endpoint. Must include a 'kind' field specifying the query type (e.g., 'HogQLQuery', 'TrendsQuery', 'FunnelsQuery', 'RetentionQuery', 'PathsQuery', 'StickinessQuery', 'LifecycleQuery', 'WebStatsTableQuery', 'WebOverviewQuery'). For HogQLQuery, must also include a 'query' field with the HogQL query string (e.g., {'kind': 'HogQLQuery', 'query': 'SELECT * FROM events LIMIT 5'}). |
| `version` | integer | No | Target a specific version for updates. Generally not needed when creating a new endpoint. |
| `is_active` | boolean | No | Whether the endpoint is active and can be queried. Defaults to true if not specified. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description for the endpoint to explain its purpose or usage |
| `sync_frequency` | string ("5min" | "30min" | "1hour" | "6hour" | "12hour" | "24hour" | "7day" | "30day") | No | Sync frequency options for data warehouse endpoints |
| `is_materialized` | boolean | No | Whether this endpoint's query results are materialized to S3 for faster access. Materialization can significantly improve query performance for frequently accessed data. |
| `cache_age_seconds` | number | No | Cache age in seconds for the endpoint. If set, responses will be cached for this duration to improve performance. |
| `derived_from_insight` | string | No | Insight ID from which this endpoint is derived, if applicable |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create error tracking autocapture controls

**Slug:** `POSTHOG_CREATE_ERROR_TRACKING_AUTOCAPTURE_CONTROL`

Tool to create a new error tracking autocapture control configuration for a PostHog project. Use when you need to set up error tracking rules for specific libraries with URL triggers, event triggers, and sampling rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking auto capture controls. |
| `library` | string | Yes | Library identifier for error tracking configuration (e.g., 'javascript', 'python', 'java') |
| `match_type` | string ("all" | "any") | No | Match type for triggers: 'all' means all conditions must match, 'any' means at least one condition must match |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `sample_rate` | string | No | Sample rate for error tracking (decimal string format between -1.00 and 1.00, e.g., '0.95' for 95%) |
| `url_triggers` | array | No | List of URL patterns that trigger error tracking |
| `url_blocklist` | array | No | List of URL patterns to exclude from error tracking |
| `event_triggers` | array | No | List of event triggers that activate error tracking autocapture |
| `linked_feature_flag` | string | No | Feature flag linked to this autocapture control (can be a string ID or a feature flag object) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create error tracking release

**Slug:** `POSTHOG_CREATE_ERROR_TRACKING_RELEASE`

Create a new error tracking release in PostHog. Use when you need to register a new application version or deployment for error tracking purposes. This helps track errors across different versions of your application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID string identifying this error tracking release |
| `hash_id` | string | Yes | Hash identifier for the release (e.g., 'release-hash-abc123') |
| `project` | string | Yes | Project name or identifier this release belongs to |
| `team_id` | integer | Yes | Team ID associated with this release |
| `version` | string | Yes | Version string of the release (e.g., '1.0.0', 'v2.3.1-beta') |
| `metadata` | object | No | Additional metadata associated with the release (optional) |
| `created_at` | string | Yes | ISO 8601 timestamp when the release was created (e.g., '2026-02-16T10:00:00Z') |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create error tracking suppression rule

**Slug:** `POSTHOG_CREATE_ERROR_TRACKING_SUPPRESSION_RULE`

Tool to create a new error tracking suppression rule for a project. Use when you need to automatically suppress specific error tracking issues based on filters. Suppression rules prevent matching errors from being reported or displayed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (UUID) for the suppression rule. Must be a valid UUID format (e.g., '550e8400-e29b-41d4-a716-446655440000'). |
| `filters` | object | Yes | Filter conditions for which errors should be suppressed. Specify error properties and conditions (e.g., {'error_type': 'test'}). |
| `order_key` | integer | Yes | Order in which suppression rules are evaluated (lower values evaluated first). Must be between -2147483648 and 2147483647. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Evaluation

**Slug:** `POSTHOG_CREATE_EVALUATION`

Create a new evaluation for a PostHog project to assess AI-generated content or responses. Use when you need to set up LLM-based evaluation criteria for quality assessment, content moderation, or performance tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the evaluation (max 400 characters) |
| `deleted` | boolean | No | Whether the evaluation is marked as deleted. Generally not needed when creating. |
| `enabled` | boolean | No | Whether the evaluation is enabled. Defaults to true if not specified. |
| `conditions` | object | No | Conditions configuration for when the evaluation should run |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Optional description of what this evaluation does |
| `output_type` | string ("boolean") | Yes | Output type of the evaluation. Currently supported: 'boolean' (Boolean Pass/Fail) |
| `output_config` | object | No | Output configuration settings for how results are formatted |
| `evaluation_type` | string ("llm_judge") | Yes | Type of evaluation. Currently supported: 'llm_judge' (LLM as a judge) |
| `evaluation_config` | object | No | Configuration settings for the evaluation logic |
| `model_configuration` | object | No | Model configuration for the evaluation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create evaluation run

**Slug:** `POSTHOG_CREATE_EVALUATION_RUN`

Tool to create a new evaluation run and enqueue a Temporal workflow to asynchronously execute the evaluation. Use when you need to run an evaluation against a specific event in PostHog. Returns HTTP 202 with workflow details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event` | string | Yes | The event name/type as a simple string |
| `timestamp` | string | Yes | ISO 8601 timestamp for the evaluation run |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `evaluation_id` | string | Yes | The UUID of the evaluation to run |
| `target_event_id` | string | Yes | The UUID of the target event to evaluate (must be an existing event in PostHog) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create event definitions

**Slug:** `POSTHOG_CREATE_EVENT_DEFINITION`

Create a new event definition in a PostHog project. Event definitions help you organize and document the events being tracked in your application. Use this to formally define events, add descriptions, assign owners, and manage event metadata. This is useful for maintaining a clean event taxonomy and ensuring your team understands what each event represents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the event definition (required). This is the event name that will be tracked and displayed in the PostHog UI (e.g., 'test_event_definition', 'user_signup', 'button_clicked'). |
| `tags` | array | No | Optional list of tags to organize and categorize the event definition. |
| `owner` | integer | No | Optional user ID of the owner responsible for this event definition. |
| `verified` | boolean | No | Optional flag to mark whether this event definition has been verified as correct. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Optional description for the event definition to provide context about what this event tracks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create experiment exposure cohort

**Slug:** `POSTHOG_CREATE_EXPERIMENT_EXPOSURE_COHORT`

Create a new exposure cohort for an experiment in a project by sending a POST request with experiment details and feature flag data. Requires experiment ID and project ID in the path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create experiment holdout

**Slug:** `POSTHOG_CREATE_EXPERIMENT_HOLDOUT`

Tool to create a new experiment holdout group in PostHog. Use when you need to set up a control group for experiments with specific filter configurations and rollout percentages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the experiment holdout (max 400 characters). |
| `filters` | array | Yes | List of filter configurations for the holdout. At least one filter with properties and rollout_percentage is required. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the experiment holdout (max 400 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create experiment saved metric

**Slug:** `POSTHOG_CREATE_EXPERIMENT_SAVED_METRIC`

Tool to create a new experiment saved metric in a PostHog project. Use when you need to define a reusable metric configuration for experiments. The query field requires 'kind' (ExperimentTrendsQuery or ExperimentFunnelsQuery) with a nested 'count_query' structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the experiment saved metric (max 400 characters) |
| `tags` | array | No | List of tags associated with the saved metric |
| `query` | object | Yes | Query configuration for the saved metric. Must include 'kind' field (e.g., 'ExperimentTrendsQuery' or 'ExperimentFunnelsQuery') and a nested 'count_query' with the actual query structure. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the experiment saved metric (max 400 characters) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Feature Flag

**Slug:** `POSTHOG_CREATE_FEATURE_FLAG`

Tool to create a new feature flag in a PostHog project. Use when you need to add feature toggles, perform gradual rollouts, or target specific user segments without deploying new code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Unique identifier key for the feature flag (e.g., 'dark-mode', 'new-checkout-flow'). Used in your code to check if the flag is enabled. Must be unique within the project. |
| `name` | string | No | Human-readable name for the feature flag displayed in the PostHog UI (e.g., 'Test Feature Flag from Composio'). If not provided, defaults to the key value. |
| `tags` | array | No | List of tags to organize and categorize the feature flag (e.g., ['frontend', 'experiment']). Helps with filtering in PostHog UI. |
| `active` | boolean | No | Whether the feature flag is active/enabled. Set to false to disable without deleting. Defaults to true. |
| `deleted` | boolean | No | Whether the feature flag is soft-deleted. Soft-deleted flags are hidden but can be restored. Generally not needed when creating a new flag. |
| `filters` | object | No | Filtering and rollout configuration. Structure: {'groups': [{'properties': [], 'rollout_percentage': 50}]}. Use 'rollout_percentage' (0-100) for gradual rollout. Use 'properties' to target specific users. If omitted, flag is enabled for all users. |
| `project_id` | string | Yes | Project ID where the feature flag will be created. Find this via the List All Projects action or from your PostHog project settings. |
| `is_simple_flag` | boolean | No | If true, creates a simple boolean flag (on/off). If false, enables advanced targeting and multivariate options. Defaults to true. |
| `ensure_experience_continuity` | boolean | No | If true, ensures users see consistent experience even if flag settings change. Useful for A/B tests where users shouldn't switch between variants. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create static cohort for feature flag

**Slug:** `POSTHOG_CREATE_FEATURE_FLAG_COHORT`

Manage feature flags for apps with create, read, update, and delete operations using PostHog's JavaScript Library or dedicated endpoint. More info in the docs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `key` | string | No | Key |
| `name` | string | No | contains the description for the flag (field name `name` is kept for backwards-compatibility)  |
| `tags` | array | No | Tags |
| `active` | boolean | No | Active |
| `deleted` | boolean | No | Deleted |
| `filters` | object | No | Filters |
| `surveys` | object | No | Surveys |
| `can_edit` | boolean | No | Can Edit |
| `features` | object | No | Features |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `experiment_set` | array | No | Experiment Set |
| `is_simple_flag` | boolean | No | Is Simple Flag |
| `usage_dashboard` | integer | No | Usage Dashboard |
| `performed_rollback` | boolean | No | Performed Rollback |
| `rollout_percentage` | integer | No | Rollout Percentage |
| `rollback_conditions` | string | No | Rollback Conditions |
| `analytics_dashboards` | array | No | Analytics Dashboards |
| `has_enriched_analytics` | boolean | No | Has Enriched Analytics |
| `ensure_experience_continuity` | boolean | No | Ensure Experience Continuity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create feature flag dashboard

**Slug:** `POSTHOG_CREATE_FEATURE_FLAG_DASHBOARD`

Manage feature flags by creating, reading, updating, and deleting them. Utilize JavaScript library or endpoint for user-specific flag status. Refer to documentation for details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `key` | string | No | Key |
| `name` | string | No | contains the description for the flag (field name `name` is kept for backwards-compatibility)  |
| `tags` | array | No | Tags |
| `active` | boolean | No | Active |
| `deleted` | boolean | No | Deleted |
| `filters` | object | No | Filters |
| `surveys` | object | No | Surveys |
| `can_edit` | boolean | No | Can Edit |
| `features` | object | No | Features |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `experiment_set` | array | No | Experiment Set |
| `is_simple_flag` | boolean | No | Is Simple Flag |
| `usage_dashboard` | integer | No | Usage Dashboard |
| `performed_rollback` | boolean | No | Performed Rollback |
| `rollout_percentage` | integer | No | Rollout Percentage |
| `rollback_conditions` | string | No | Rollback Conditions |
| `analytics_dashboards` | array | No | Analytics Dashboards |
| `has_enriched_analytics` | boolean | No | Has Enriched Analytics |
| `ensure_experience_continuity` | boolean | No | Ensure Experience Continuity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create file system

**Slug:** `POSTHOG_CREATE_FILE_SYSTEM`

Tool to create a new file system resource in PostHog with specified metadata and hierarchy. Use when you need to create folders, files, or other organizational structures in a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID identifier for the file system resource |
| `ref` | string | No | Reference identifier for the file system (max 100 characters) |
| `href` | string | No | URL reference to the file system resource |
| `meta` | object | No | Additional metadata associated with the file system |
| `path` | string | Yes | Path of the file system resource |
| `type` | string | Yes | Type of the file system resource (max 100 characters) |
| `depth` | integer | No | Depth level of the file system resource in the hierarchy |
| `shortcut` | boolean | No | Whether this file system is a shortcut |
| `created_at` | string | Yes | ISO 8601 timestamp of when the file system was created |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `last_viewed_at` | string | No | ISO 8601 timestamp of when the file system was last viewed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create file system shortcut

**Slug:** `POSTHOG_CREATE_FILE_SYSTEM_SHORTCUT`

Create a new file system shortcut in a PostHog project. Requires 'file_system_shortcut:write' permission. Returns the created shortcut with all its properties including UUID, path, type, and creation timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | UUID identifier for the file system shortcut (e.g., '550e8400-e29b-41d4-a716-446655440000'). Optional - server generates this if not provided. |
| `ref` | string | No | Optional reference identifier (max 100 characters). |
| `href` | string | No | Optional URL reference for the file system shortcut. |
| `path` | string | Yes | File system path for the shortcut (e.g., '/test/shortcut/path'). |
| `type` | string | Yes | Type of file system shortcut, max 100 characters (e.g., 'folder', 'file'). |
| `created_at` | string | No | Timestamp when the file system shortcut was created, in ISO 8601 format (e.g., '2026-02-16T10:00:00Z'). Optional - server generates this if not provided. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create groups types metrics

**Slug:** `POSTHOG_CREATE_GROUP_TYPE_METRIC`

Tool to create a new metric for a specific group type in a PostHog project. Use when you need to define custom metrics to track group-level analytics (e.g., company revenue, team activity). Requires project_id, group_type_index, metric id (UUID), name, and filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID identifier for the metric. Must be a valid UUID format (e.g., '550e8400-e29b-41d4-a716-446655440000'). |
| `name` | string | Yes | Human-readable name for the metric. Maximum 255 characters. |
| `format` | string ("numeric" | "currency") | No | Format type for the metric |
| `display` | string ("number" | "sparkline") | No | Display type for the metric |
| `filters` | object | Yes | Filter configuration for the metric. Defines what data the metric tracks. Use empty dict {} for no filters. |
| `interval` | integer | No | Interval in days for the metric calculation. Controls the time window for the metric. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `group_type_index` | integer | Yes | Index of the group type (e.g., 0 for the first group type, 1 for the second). Use /api/projects/{project_id}/groups_types/ to list available group types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create hog function

**Slug:** `POSTHOG_CREATE_HOG_FUNCTION`

Create a new hog function in PostHog. Hog functions are serverless functions that can be triggered by events, used for transformations, destinations, or site applications. Use when you need to set up custom event processing, integrations, or in-app features like notification bars.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hog` | string | No | Hog code for custom function logic. Used for advanced custom implementations. |
| `name` | string | Yes | Name of the hog function (e.g., 'Test Hog Function', 'Notification Bar'). Maximum length: 400 characters. |
| `type` | string | Yes | Type of hog function (e.g., 'site_app', 'destination', 'transformation'). Determines how and where the function executes. |
| `inputs` | object | Yes | Dictionary of input parameter values. Keys are parameter names (e.g., 'notification', 'position', 'backgroundColor'). Values contain the input configuration including the actual value. |
| `deleted` | boolean | No | Whether the hog function is soft-deleted. Generally not needed when creating a new function. |
| `enabled` | boolean | No | Whether the hog function is enabled. Defaults to true. |
| `filters` | object | No | Filtering configuration for when the hog function should execute. |
| `masking` | object | No | Masking configuration for sensitive data in hog function. |
| `icon_url` | string | No | URL or path to the icon for this hog function (e.g., '/static/hedgehog/list-hog.png'). Used for display in UI. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of what the hog function does (e.g., 'Test hog function for API validation'). |
| `template_id` | string | Yes | Template ID to use for the hog function (e.g., 'template-notification-bar', 'template-slack-webhook'). Maximum length: 400 characters. |
| `execution_order` | integer | No | Order in which this function should execute relative to other hog functions. Range: 0-32767. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create insight variable

**Slug:** `POSTHOG_CREATE_INSIGHT_VARIABLE`

Create a new insight variable for a PostHog project. Insight variables allow you to define reusable parameters that can be referenced across insights and queries. Use when you need to create configurable variables like user segments, date ranges, or custom metrics that can be used in multiple insights.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the insight variable (e.g., 'User Segment', 'Final Test Variable'). Maximum length: 400 characters. |
| `type` | string ("String" | "Number" | "Boolean" | "List" | "Date") | Yes | Data type of the insight variable. Determines how the variable is interpreted and used in insights. |
| `values` | string | No | Optional values or configuration for the insight variable. Can be used to define allowed values or additional metadata. |
| `code_name` | string | Yes | Unique code name identifier for the insight variable (e.g., 'user_segment', 'test_var_final_check'). This is used to reference the variable in insights and queries. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `default_value` | string | No | Default value for the insight variable. The value type should match the specified 'type' field. For example, if type is 'String', provide a string value; if type is 'Number', provide a numeric value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create live debugger breakpoint

**Slug:** `POSTHOG_CREATE_LIVE_DEBUGGER_BREAKPOINT`

Tool to create a new live debugger breakpoint in a PostHog project. Use when you need to set up debugging instrumentation for a specific file and line number in your application code. Client applications will receive this breakpoint configuration and can pause execution or log data when that line is reached.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Whether the breakpoint is enabled. Set to false to create a disabled breakpoint. Defaults to true. |
| `filename` | string | Yes | Name of the source file where the breakpoint should be set (e.g., 'main.py', 'app.js', 'src/utils/helper.py'). |
| `condition` | string | No | Optional condition expression that must evaluate to true for the breakpoint to trigger. Leave empty for unconditional breakpoint. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS. |
| `repository` | string | No | Repository identifier where the file is located. Format: 'Owner/RepoName' (e.g., 'PostHog/posthog', 'myorg/myrepo'). |
| `line_number` | integer | Yes | Line number in the source file where the breakpoint should be set. Must be a positive integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create LLM Analytics Summarization

**Slug:** `POSTHOG_CREATE_LLM_ANALYTICS_SUMMARIZATION`

Generate an AI-powered summary of an LLM trace or event. This endpoint analyzes the provided trace/event, generates a line-numbered text representation, and uses an LLM to create a concise summary with line references in [L45] or [L45-52] format. Use when you need to quickly understand complex LLM interactions, debug traces, or generate human-readable explanations of AI system behavior.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data to summarize. For traces: {trace, hierarchy}. For events: {event}. Structure depends on summarize_type. |
| `mode` | string ("minimal" | "detailed") | No | Summary detail level: 'minimal' for 3-5 bullet points, 'detailed' for 5-10 bullet points with more depth |
| `model` | string | No | LLM model to use for generating the summary (e.g., 'gpt-4', 'claude-3'). Defaults based on provider if not specified. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `force_refresh` | boolean | No | Force regenerate summary, bypassing cache. Set to true to get a fresh summary even if one exists. |
| `summarize_type` | string ("trace" | "event") | Yes | Type of entity to summarize: 'trace' for LLM traces or 'event' for individual events |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create LLM Analytics Text Representation

**Slug:** `POSTHOG_CREATE_LLM_ANALYTICS_TEXT_REPRESENTATION`

Tool to generate human-readable text representations of LLM trace events for display, logging, or analysis. Use when you need to convert LLM analytics events ($ai_generation, $ai_span, $ai_embedding, or $ai_trace) into formatted text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Event data to stringify. For traces, should include 'trace' and 'hierarchy' fields. For generations, should include 'id' and 'properties' with model, input, output, and cost details. |
| `options` | object | No | Optional configuration for text generation |
| `event_type` | string ("$ai_generation" | "$ai_span" | "$ai_embedding" | "$ai_trace") | Yes | Type of LLM event to stringify. Must be one of: $ai_generation (individual LLM API calls), $ai_span (logical spans), $ai_embedding (embedding generation), or $ai_trace (full traces) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Logs Export

**Slug:** `POSTHOG_CREATE_LOGS_EXPORT`

Tool to create a logs export job using HogQL queries in PostHog. Use when you need to export event logs or query results for analysis. The endpoint creates an asynchronous export job and returns metadata including the export ID, format, and filename that can be used to retrieve the exported data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | object | Yes | Query object containing the HogQL query specification for exporting logs |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create new organization with configurable access

**Slug:** `POSTHOG_CREATE_ORGANIZATION`

Create a new PostHog organization with configurable security and notification settings. This action creates a new organization and automatically provisions a default project with an API token. The organization will be immediately active and ready for use. Returns complete organization details including: - Organization ID, name, and URL slug - Automatically created default project and team - API token for the default team - All security and access control settings Requires organization:write permission. The authenticated user becomes the first member of the newly created organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the organization to create. This will be displayed throughout the PostHog interface and a URL-friendly slug will be automatically generated from it. |
| `enforce_2fa` | boolean | No | Whether to require two-factor authentication (2FA) for all organization members. If not specified, defaults to null (not enforced). Set to true to mandate 2FA for enhanced security. |
| `is_member_join_email_enabled` | boolean | No | Whether to send email notifications when new members join the organization. If not specified, defaults to true. Set to false to disable join notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create organization invite with role and email

**Slug:** `POSTHOG_CREATE_ORGANIZATION_INVITE`

Create and send an organization invitation to a user via email. This allows you to invite people to join your PostHog organization with a specific role (member, admin, or owner). The action creates an invite that can optionally send an email notification to the recipient. Returns the complete invite details including invite ID, timestamps, and the user who created it. Successful invitations return a 201 status with full invite details. Use cases: - Invite team members to collaborate on analytics - Grant admin access to manage organization settings - Add owners with full organizational control - Create invites without immediate email notification (set send_email=false)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `level` | integer | No | The role level to assign to the invited member. Options: 1 (member - standard access), 8 (admin - elevated permissions), 15 (owner - full control). If not specified, organization defaults will be used. |
| `message` | string | No | A custom message to include with the invitation. This will be displayed to the recipient when they receive the invite. |
| `first_name` | string | No | The first name of the person being invited. This is optional and will be used in the invitation email if provided. |
| `send_email` | boolean | No | Whether to send an invitation email to the target email address. Set to true to send email (default), false to create the invite without sending an email. |
| `target_email` | string | Yes | The email address of the person you want to invite to the organization. Must be a valid email format. |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization to send the invite to. You can get this from the user's profile or organization list. |
| `private_project_access` | string | No | List of private projects to grant access to, with their corresponding access levels. Format: [{'team_id': <project_id>, 'level': <access_level>}]. Leave empty for no private project access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create organization proxy record for custom domain

**Slug:** `POSTHOG_CREATE_ORGANIZATION_PROXY_RECORD`

Create a managed reverse proxy record for an organization to enable custom domain routing for PostHog analytics events. This bypasses ad blockers by routing analytics through your own domain. After creating the record, you must: 1. Create a CNAME DNS record pointing your domain to the returned target_cname 2. Wait 2-30 minutes for DNS propagation and SSL certificate provisioning 3. The status will progress from 'waiting' → 'issuing' → 'live' IMPORTANT: If using Cloudflare, set the CNAME to "DNS only" (disable proxy) to avoid SSL certificate provisioning issues. Requires organization write access (organization:write permission).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | The custom domain name to be used as a reverse proxy for PostHog analytics (e.g., 'analytics.yourdomain.com'). This domain will be configured with a CNAME record pointing to PostHog's proxy infrastructure to bypass ad blockers. |
| `organization_id` | string | Yes | The UUID of the organization where the proxy record will be created. Example: '019c0f23-fee2-0000-4505-c38851f281ad' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create organization role with feature flag levels

**Slug:** `POSTHOG_CREATE_ORGANIZATION_ROLE`

Create a new custom role within a PostHog organization with optional feature flag access permissions. This action creates an organization role that can be assigned to members to control their access levels. The role can include specific feature flag access permissions via the feature_flags_access_level parameter. Returns the created role with its unique ID, name, creation timestamp, and other metadata. Security: Requires PersonalAPIKeyAuth with organization admin permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The display name for the new role (e.g., 'Feature Flag Manager', 'Analytics Reviewer') |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization where the role will be created |
| `feature_flags_access_level` | integer | No | Optional integer representing the permission level for feature flag operations. Higher values typically grant more permissions. If not specified, the role will be created without specific feature flag access restrictions |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create domain with saml for organization

**Slug:** `POSTHOG_CREATE_ORGANIZATION_SAML_DOMAIN`

Create and configure an authentication domain with SAML SSO for a PostHog organization. Requires Enterprise plan. Adds an email domain (e.g., 'company.com') to your organization and configures SAML Single Sign-On for users with matching email addresses. After creation, verify domain ownership via DNS TXT record before SAML activates. SAML parameters (entity_id, acs_url, x509_cert) come from your Identity Provider (Okta, OneLogin, Azure AD, etc.). Workflow: 1) Create domain (this endpoint) 2) Add DNS TXT record from verification_challenge 3) Verify domain 4) Configure IdP with PostHog SAML settings 5) Test authentication. Returns 201 with domain config on success, 403 if not on Enterprise plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | The email domain to configure for SAML authentication (e.g., 'company.com'). Users with email addresses ending in this domain will be required to authenticate via SAML. |
| `saml_acs_url` | string | No | SAML Assertion Consumer Service (ACS) URL from your identity provider. The endpoint where SAML authentication requests are sent (e.g., 'https://idp.example.com/sso/saml'). Also called SAML endpoint or IdP sign-on URL. |
| `saml_entity_id` | string | No | SAML Entity ID (also called IdP Issuer) from your identity provider. Usually a URL that uniquely identifies your IdP (e.g., 'https://idp.example.com/entityid'). Required for SAML authentication. |
| `saml_x509_cert` | string | No | X.509 certificate from your SAML identity provider used to validate SAML assertions. Must be in PEM format. Include the full certificate text with or without BEGIN/END CERTIFICATE headers. Preserve all spaces and newlines from the .pem file. |
| `organization_id` | string | Yes | UUID of the PostHog organization to add the authentication domain to. Found in organization settings or via the organizations API endpoint. |
| `sso_enforcement` | string | No | SSO enforcement level for this domain. Valid values: 'strict' (all users must use SSO), 'google-oauth2' (allow Google OAuth as alternative), or empty string for no enforcement. Controls whether users can bypass SAML authentication. |
| `jit_provisioning_enabled` | boolean | No | Enable Just-in-Time (JIT) user provisioning. When true, new users with matching email domains will automatically have accounts created when they authenticate via SAML. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create persisted folder

**Slug:** `POSTHOG_CREATE_PERSISTED_FOLDER`

Tool to create a new persisted folder in a PostHog project. Use when you need to create a new folder for organizing data storage with a specific type and configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID identifier for the persisted folder |
| `path` | string | No | Path of the persisted folder |
| `type` | string ("home" | "pinned" | "custom_products") | Yes | Type of the persisted folder: 'home' (Home), 'pinned' (Pinned), or 'custom_products' (Custom Products) |
| `protocol` | string | No | Protocol used for the persisted folder (maximum 64 characters) |
| `created_at` | string | Yes | ISO 8601 datetime when the persisted folder was created |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `updated_at` | string | Yes | ISO 8601 datetime when the persisted folder was last updated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create person path with format option

**Slug:** `POSTHOG_CREATE_PERSON_PATH`

Retrieve path analytics for a specific person within a PostHog project. This endpoint returns the navigation paths and user journey data for a person. Note: This endpoint requires session-based authentication and does not support Personal API Key access. To use this endpoint, you must be authenticated via the PostHog web application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Id |
| `name` | string | Yes | Name |
| `uuid` | string | Yes | Uuid |
| `format` | string ("csv" | "json") | No | Format |
| `created_at` | string | Yes | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | string | No | Properties |
| `distinct_ids` | array | Yes | Distinct Ids |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create product tour

**Slug:** `POSTHOG_CREATE_PRODUCT_TOUR`

Tool to create a new product tour in a PostHog project. Use when you need to set up guided tours to onboard users or highlight features. Requires a project_id and a name for the tour.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the product tour. This is the display name shown to users and in the PostHog UI. Maximum length: 400 characters. |
| `content` | object | No | Content configuration of the product tour, defining the steps, messages, and UI elements. |
| `archived` | boolean | No | Whether the product tour is archived. Archived tours are hidden from active use. |
| `end_date` | string | No | ISO 8601 timestamp when the product tour should become inactive (e.g., '2024-12-31T23:59:59Z'). |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `start_date` | string | No | ISO 8601 timestamp when the product tour should become active (e.g., '2024-01-01T00:00:00Z'). |
| `auto_launch` | boolean | No | Whether the product tour should automatically launch when conditions are met. |
| `description` | string | No | Optional description of the product tour to explain its purpose or content. |
| `linked_flag_id` | integer | No | ID of a feature flag to link with this product tour for targeting control. |
| `targeting_flag_filters` | object | No | Filters to define which users should see the product tour based on their properties or behaviors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project action with format

**Slug:** `POSTHOG_CREATE_PROJECT_ACTION`

This POST endpoint creates actions for a project, accepts various data types, requires project_id and action data, optionally outputs in CSV/JSON, and needs PersonalAPIKeyAuth, returning a 201 with action details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Id (read-only, server-generated) |
| `name` | string | No | Name |
| `tags` | array | No | Tags |
| `steps` | array | No | Steps |
| `format` | string ("csv" | "json") | No | Format |
| `deleted` | boolean | No | Deleted |
| `team_id` | integer | No | Team Id (read-only, server-generated) |
| `is_action` | boolean | No | Is Action |
| `created_at` | string | No | Created At (read-only, server-generated) |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `post_to_slack` | boolean | No | Post To Slack |
| `bytecode_error` | string | No | Bytecode Error (read-only, server-generated) |
| `is_calculating` | boolean | No | Is Calculating (read-only, server-generated) |
| `last_calculated_at` | string | No | Last Calculated At |
| `slack_message_format` | string | No | Slack Message Format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project cohorts

**Slug:** `POSTHOG_CREATE_PROJECT_COHORT`

Create cohorts for a specified project by POSTing JSON-form data to "/api/projects/{project_id}/cohorts/". Provide project_id in URL and the necessary payload, adhering to JSON schema constraints. Authentication required. Returns 201 upon success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the cohort (required) |
| `query` | string | No | Query |
| `groups` | string | No | Groups - defines cohort criteria for dynamic cohorts |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `is_static` | boolean | No | Is Static - set to true for static cohorts |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project dashboard

**Slug:** `POSTHOG_CREATE_PROJECT_DASHBOARD`

The POST endpoint creates a dashboard within a project using a `project_id`, accepting details in JSON/form formats. It uses 'PersonalAPIKeyAuth' for security and returns HTTP 201 with dashboard details on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the dashboard (required) |
| `tags` | array | No | List of tags for categorizing and organizing the dashboard. Example: ['analytics', 'revenue', 'weekly'] |
| `tiles` | array | No | List of dashboard tiles/widgets. Each tile represents an insight, text card, or other dashboard element. Usually left empty on creation and populated later. |
| `pinned` | boolean | No | Whether the dashboard is pinned |
| `deleted` | boolean | No | Whether the dashboard is deleted |
| `filters` | string | No | Dashboard-level filters as a JSON object. Example: {'date_from': '-7d', 'date_to': None}. These filters apply to all insights on the dashboard. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description of the dashboard |
| `use_template` | string | No | Template ID to use for creating the dashboard. If provided, the dashboard will be created based on this template's structure and insights. |
| `use_dashboard` | integer | No | Dashboard ID to duplicate. If provided, creates a copy of an existing dashboard with all its tiles and settings. |
| `delete_insights` | boolean | No | When duplicating a dashboard (use_dashboard), set to true to exclude the insights from the copy. Defaults to false. |
| `restriction_level` | integer | No | Access control restriction level for the dashboard. Common values: 21 (everyone in project), 37 (only creator). Controls who can view and edit the dashboard. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create new project experiment

**Slug:** `POSTHOG_CREATE_PROJECT_EXPERIMENT`

Create a new experiment in a specific project using JSON, form, or multipart data. Requires project_id and experiment details, secured with PersonalAPIKeyAuth. Generates a 201 response with experiment info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the experiment |
| `filters` | string | No | Filters |
| `archived` | boolean | No | Archived |
| `end_date` | string | No | End Date |
| `parameters` | string | No | Parameters |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | No | Start Date |
| `description` | string | No | Description |
| `feature_flag_key` | string | Yes | Feature Flag Key for the experiment |
| `secondary_metrics` | string | No | Secondary Metrics |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project insights with format option

**Slug:** `POSTHOG_CREATE_PROJECT_INSIGHTS_WITH_FORMAT_OPTION`

Create a new analytics insight in a PostHog project. Insights are saved queries that visualize data from your analytics events. Use this to create trends, funnels, retention, or other analytics visualizations. You can define the insight using either: - Legacy 'filters' format (simpler, widely supported) - Modern 'query' format (more powerful, recommended for new integrations) The optional 'format' parameter controls response format: - 'json' (default): Returns structured JSON with insight metadata - 'csv': Returns CSV-formatted representation of the insight Requires a valid project_id. Returns HTTP 201 on success with the created insight details including a unique ID and short_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Display name for the insight (e.g., 'Weekly Active Users', 'Conversion Funnel') |
| `tags` | array | No | List of tags for organizing and filtering insights (e.g., ['analytics', 'weekly-report', 'conversion']) |
| `order` | integer | No | Display order of the insight when shown in lists or dashboards (lower numbers appear first) |
| `query` | string | No | Modern query-based insight definition using PostHog query nodes. For TRENDS: {"kind": "TrendsQuery", "series": [{"kind": "EventsNode", "event": "$pageview"}], "dateRange": {"date_from": "-30d"}}. Use either 'query' or 'filters', not both |
| `saved` | boolean | No | Whether to save this insight for future access. Set to true to persist the insight, false for temporary/exploratory insights |
| `format` | string ("csv" | "json") | No | Response format. Use 'csv' to get CSV-formatted output, or 'json' (default) for JSON response |
| `deleted` | boolean | No | Whether the insight is soft-deleted. Set to true to create a deleted insight (uncommon use case) |
| `filters` | string | No | Legacy filters object defining the insight query (events, properties, date ranges, etc.). For TRENDS insights, include: {"insight": "TRENDS", "events": [{"id": "event_name", "type": "events"}], "date_from": "-7d"}. Use either 'filters' or 'query', not both |
| `favorited` | boolean | No | Whether to mark this insight as favorited/starred for quick access |
| `dashboards` | array | No |          DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.         A dashboard ID for each of the dashboards that this insight is displayed on.           |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Detailed description of what the insight measures and why it's important |
| `derived_name` | string | No | Auto-generated name based on insight configuration. Leave empty to auto-generate from filters/query |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a notebook in a project

**Slug:** `POSTHOG_CREATE_PROJECT_NOTEBOOK`

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Title of the notebook |
| `content` | string | No | Content of the notebook as a JSON document structure |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `text_content` | string | No | Plain text content of the notebook |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project pipeline frontend app job

**Slug:** `POSTHOG_CREATE_PROJECT_PIPELINE_FRONTEND_APP_JOB`

Create a job for a pipeline frontend app config in a project. Requires `project_id` and config `id`, accepting JSON/form-data. Returns the created job's details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin config. |
| `job` | object | No | Job payload schema for plugin jobs |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Retrieve Retention Insights For Project

**Slug:** `POSTHOG_CREATE_PROJECT_RETENTION_INSIGHT`

Create and retrieve retention insights for a project using PostHog's Query API. Analyzes how users return over time based on specified events or actions. Uses the /api/projects/{project_id}/query/ endpoint with a RetentionQuery. Requires a project ID and authenticated access with 'insight:read' permission. If no query is provided, returns default retention data for $pageview events over 7 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | object | No | A RetentionQuery object defining how to analyze user retention over time. Retention analysis tracks users who performed an initial event (targetEntity) and returned to perform a follow-up event (returningEntity) within specified time intervals. If not provided, defaults to analyzing $pageview retention over 7 days. Query Structure: 'kind' (required) must be 'RetentionQuery'. 'retentionFilter' (required) contains: 'retentionType' ('retention_first_time' for first occurrence cohorts, 'retention_recurring' for any occurrence), 'totalIntervals' (number of time periods to analyze), 'period' ('Hour', 'Day', 'Week', or 'Month'), 'targetEntity' (initial event to enter cohort), 'returningEntity' (event to count as retained). Optional fields: 'dateRange' with 'date_from'/'date_to', 'filterTestAccounts' boolean, 'properties' array. |
| `refresh` | string | No | Whether to refresh the query results. Options: 'async', 'blocking', 'force_async', 'force_blocking', 'force_cache', 'lazy_async'. |
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project subscription with delivery options

**Slug:** `POSTHOG_CREATE_PROJECT_SUBSCRIPTION`

Create a subscription for a given project by providing required details such as delivery method, frequency, and starting date. Requires a project ID and supports various content types. Returns the newly created subscription. Security: PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Count |
| `title` | string | No | Title |
| `deleted` | boolean | No | Deleted |
| `insight` | integer | No | Insight |
| `bysetpos` | integer | No | Bysetpos |
| `interval` | integer | No | Interval |
| `byweekday` | array | No | Byweekday |
| `dashboard` | integer | No | Dashboard |
| `frequency` | string ("daily" | "weekly" | "monthly" | "yearly") | Yes | * `daily` - Daily * `weekly` - Weekly * `monthly` - Monthly * `yearly` - Yearly  |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | Yes | Start Date |
| `until_date` | string | No | Until Date |
| `target_type` | string ("email" | "slack" | "webhook") | Yes | * `email` - Email * `slack` - Slack * `webhook` - Webhook |
| `target_value` | string | Yes | Target Value |
| `invite_message` | string | No | Invite Message |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project surveys with questions and targets

**Slug:** `POSTHOG_CREATE_PROJECT_SURVEY`

Create surveys in a project by providing a project ID and details like type, questions, and targets in JSON, form-data, or urlencoded format. Use PersonalAPIKeyAuth for security. Get a survey object on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Id (auto-generated by server if not provided) |
| `name` | string | Yes | Name |
| `type` | string ("popover" | "widget" | "api") | Yes | * `popover` - popover * `widget` - widget * `button` - button * `email` - email * `full_screen` - full screen * `api` - api  |
| `archived` | boolean | No | Archived |
| `end_date` | string | No | End Date |
| `questions` | string | No |          The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.         Basic (open-ended question)         - `type`: `open`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `branching`: Branching logic for the question. See branching types below for details.         Link (a question with a link)         - `type`: `link`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `link`: The URL associated with the question.         - `branching`: Branching logic for the question. See branching types below for details.         Rating (a question with a rating scale)         - `type`: `rating`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `display`: Display style of the rating (`number` or `emoji`).         - `scale`: The scale of the rating (`number`).         - `lowerBoundLabel`: Label for the lower bound of the scale.         - `upperBoundLabel`: Label for the upper bound of the scale.         - `branching`: Branching logic for the question. See branching types below for details.         Multiple choice         - `type`: `single_choice` or `multiple_choice`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `choices`: An array of choices for the question.         - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).         - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).         - `branching`: Branching logic for the question. See branching types below for details.         Branching logic can be one of the following types:         Next question: Proceeds to the next question         ```json         {             "type": "next_question"         }         ```         End: Ends the survey, optionally displaying a confirmation message.         ```json         {             "type": "end"         }         ```         Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.         ```json         {             "type": "response_based",             "responseValues": {                 "responseKey": "value"             }         }         ```         Specific question: Proceeds to a specific question by index.         ```json         {             "type": "specific_question",             "index": 2         }         ```           |
| `appearance` | string | No | Appearance |
| `conditions` | string | No | Conditions |
| `created_at` | string | No | Created At (auto-generated by server if not provided) |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | No | Start Date |
| `description` | string | No | Description |
| `linked_flag_id` | integer | No | Linked Flag Id |
| `iteration_count` | integer | No | Iteration Count |
| `responses_limit` | integer | No | Responses Limit |
| `current_iteration` | integer | No | Current Iteration |
| `targeting_flag_id` | integer | No | Targeting Flag Id |
| `iteration_start_dates` | array | No | Iteration Start Dates |
| `remove_targeting_flag` | boolean | No | Remove Targeting Flag |
| `targeting_flag_filters` | string | No | Targeting Flag Filters |
| `iteration_frequency_days` | integer | No | Iteration Frequency Days |
| `current_iteration_start_date` | string | No | Current Iteration Start Date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create query in project by id

**Slug:** `POSTHOG_CREATE_QUERY_IN_PROJECT_BY_ID`

The `/api/projects/{project_id}/query/` POST endpoint allows users to submit queries for a specific project by providing the project ID in the URL and the query details in JSON or form data. Authentication is required and it returns query results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `async` | boolean | No | (Experimental) Whether to run the query asynchronously. Defaults to False. If True, the `id` of the query can be used to check the status and to cancel it.  |
| `query` | object | Yes | Query object for PostHog data analysis. Supported query kinds include HogQLQuery, FunnelsQuery, TrendsQuery, etc. For HogQL: {"kind": "HogQLQuery", "query": "select * from events limit 100"}. For FunnelsQuery, funnel-specific settings (funnelWindowInterval, funnelWindowIntervalUnit, funnelVizType, etc.) must be nested inside the funnelsFilter object: {"kind": "FunnelsQuery", "series": [...], "funnelsFilter": {"funnelWindowInterval": 14, "funnelWindowIntervalUnit": "day"}}. |
| `refresh` | string ("async" | "async_except_on_cache_miss" | "blocking" | "force_async" | "force_blocking" | "force_cache" | "lazy_async") | No | Enum for refresh mode options |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `client_query_id` | string | No | Client provided query ID. Can be used to retrieve the status or cancel the query.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create session recording playlists

**Slug:** `POSTHOG_CREATE_SESSION_RECORDING_PLAYLIST`

Create playlists of session recordings for a specified project. Requires 'project_id' path parameter and personal API key with write access. Supports JSON, form-encoded, or multipart data. Returns 201 on success with playlist details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Id (read-only, auto-generated by server) |
| `name` | string | Yes | Name of the session recording playlist (required) |
| `type` | string | Yes | Playlist type (required) - must be either 'filters' (for dynamic filter-based playlists) or 'collection' (for manually curated recording collections) |
| `pinned` | boolean | No | Whether the playlist should be pinned to the top of the playlist list for easy access |
| `deleted` | boolean | No | Soft deletion flag - set to true to mark the playlist as deleted without removing it |
| `filters` | string | No | Filter configuration for 'filters' type playlists. Can include: events (list of event filters), duration (recording length filters), date_from/date_to (date ranges), actions (action-based filters), and filter_group (complex filter combinations). Only applicable when type='filters'. |
| `short_id` | string | No | Short Id (read-only, auto-generated by server) |
| `created_at` | string | No | Created At (read-only, auto-generated by server) |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Optional description explaining the purpose or content of this playlist |
| `derived_name` | string | No | Auto-generated alternative name for the playlist based on filters |
| `last_modified_at` | string | No | Last Modified At (read-only, auto-generated by server) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate AI summary for session recording

**Slug:** `POSTHOG_CREATE_SESSION_RECORDING_SUMMARY`

Generate an AI-powered summary for a session recording. Requires PostHog AI feature to be enabled. Provide the project_id and the session recording's UUID to get an AI-generated summary including key activities, user interactions, and insights about the session. Note: This endpoint requires PostHog AI to be enabled for your organization and may only be available on paid plans. Returns 403 Forbidden if the feature is not accessible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this session recording. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Surveys Summary Headline

**Slug:** `POSTHOG_CREATE_SURVEY_SUMMARY_HEADLINE`

Tool to create or regenerate a summary headline for a survey. Use when you need to generate an AI-powered headline summary of survey responses for a specific project survey. The endpoint processes survey data to create a concise headline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create warehouse saved query

**Slug:** `POSTHOG_CREATE_WAREHOUSE_SAVED_QUERY`

Create a new warehouse saved query in PostHog for data warehouse operations. Use this to define reusable HogQL queries that can be executed against your warehouse tables. The query name must contain only letters, numbers, underscores, dots, or dollar signs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the warehouse saved query. Must contain only letters, numbers, underscores (_), dots (.), or dollar signs ($). Maximum length is 128 characters. |
| `query` | object | Yes | HogQL query object containing the query kind and query string to execute |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Web Experiment

**Slug:** `POSTHOG_CREATE_WEB_EXPERIMENT`

Create a new web experiment in a PostHog project. Web experiments allow you to run A/B tests by dynamically transforming DOM elements on your website based on feature flag variants. Use when you want to test different UI variations, messaging, or layouts without deploying new code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier for the web experiment |
| `name` | string | Yes | Human-readable name for the web experiment (max 400 characters) |
| `variants` | object | Yes | Dictionary mapping variant names to their configurations. Common variant names include 'control', 'test', 'variant_a', 'variant_b'. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `feature_flag_key` | string | Yes | Key of the feature flag that controls this web experiment. The feature flag must exist in the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete alert

**Slug:** `POSTHOG_DELETE_ALERT`

Delete an alert configuration by providing its UUID and the associated project ID. Requires 'alert:write' permission. Returns no content with a 204 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this alert configuration. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Profile Config

**Slug:** `POSTHOG_DELETE_CUSTOMER_PROFILE_CONFIG`

Tool to delete a customer profile configuration by ID in a PostHog project. Use when you need to remove a customer profile config that is no longer needed. Returns a 204 No Content status on successful deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this customer profile config. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete desktop recording

**Slug:** `POSTHOG_DELETE_DESKTOP_RECORDING`

Tool to delete a desktop meeting recording by its UUID and project ID. Use when you need to permanently remove a desktop recording from a PostHog project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this desktop recording. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete endpoint

**Slug:** `POSTHOG_DELETE_ENDPOINT`

Delete an endpoint and clean up materialized query. Returns no content with a 204 status on success. Use when you need to remove an endpoint configuration from a PostHog project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | URL-safe name for the endpoint |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete error tracking autocapture controls

**Slug:** `POSTHOG_DELETE_ERROR_TRACKING_AUTOCAPTURE_CONTROL`

Delete an error tracking autocapture control configuration by UUID and project ID. Use when you need to remove autocapture settings for error tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking auto capture controls. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete error tracking grouping rule

**Slug:** `POSTHOG_DELETE_ERROR_TRACKING_GROUPING_RULE`

Delete a specific error tracking grouping rule by ID. Use when you need to remove a custom grouping rule that is no longer needed or was created incorrectly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking grouping rule. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete error tracking release

**Slug:** `POSTHOG_DELETE_ERROR_TRACKING_RELEASE`

Delete an error tracking release by its UUID and project ID. Use when you need to remove a specific release from error tracking. Requires 'error_tracking:write' scope. Returns 204 No Content on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking release. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Error Tracking Suppression Rule

**Slug:** `POSTHOG_DELETE_ERROR_TRACKING_SUPPRESSION_RULE`

Tool to delete an error tracking suppression rule by its UUID. Use when you need to remove a suppression rule that is no longer needed. Requires 'error_tracking:write' permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking suppression rule. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete experiment holdout

**Slug:** `POSTHOG_DELETE_EXPERIMENT_HOLDOUT`

Delete an experiment holdout by providing its ID and the associated project ID. Requires 'experiment:write' permission. Returns no content with a 204 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment holdout. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete experiment saved metric

**Slug:** `POSTHOG_DELETE_EXPERIMENT_SAVED_METRIC`

Tool to delete an experiment saved metric by ID from a PostHog project. Use when you need to remove a saved metric configuration from an experiment. Returns HTTP 204 No Content on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment saved metric. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove feature flag role access by id

**Slug:** `POSTHOG_DELETE_FEATURE_FLAG_ROLE_ACCESS`

DELETE /api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access/{id}: Remove role access from a feature flag in a project by ID, requiring authorization. Expect no response body upon success (204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag role access. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `feature_flag_id` | integer | Yes | Feature Flag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete file system

**Slug:** `POSTHOG_DELETE_FILE_SYSTEM`

Tool to delete a file system resource in PostHog by UUID. Use when you need to permanently remove a file system. Returns deletion information including undo options if available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this file system. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Groups Types Metrics

**Slug:** `POSTHOG_DELETE_GROUP_TYPE_METRIC`

Tool to delete a group usage metric by its UUID within a specific project and group type. Use when you need to remove a metric that tracks group-level analytics. Requires 'group:write' permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this group usage metric. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `group_type_index` | integer | Yes | Group type index (0-4) identifying which group type to access |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete insight variables

**Slug:** `POSTHOG_DELETE_INSIGHT_VARIABLE`

Delete an insight variable by its UUID from a specified project. Requires 'insight_variable:write' permission. Returns no content with a 204 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this insight variable. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete live debugger breakpoint

**Slug:** `POSTHOG_DELETE_LIVE_DEBUGGER_BREAKPOINT`

Delete a live debugger breakpoint by providing its UUID and project ID. Requires 'live_debugger:write' permission. Returns no content with a 204 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this live debugger breakpoint. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete organization by uuid

**Slug:** `POSTHOG_DELETE_ORGANIZATION`

Delete an organization by its UUID. Requires a 'PersonalAPIKeyAuth' with 'organization:write' permission. On success, returns a 204 status code with no response body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove organization batch export by uuid

**Slug:** `POSTHOG_DELETE_ORGANIZATION_BATCH_EXPORT`

Delete a specific batch export by its UUID in an organization. Requires PersonalAPIKeyAuth with batch_export:write permission. Returns 204 on success with no response body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this batch export. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove domain by uuid from organization

**Slug:** `POSTHOG_DELETE_ORGANIZATION_DOMAIN`

Delete a specific domain by its UUID within an organization, given valid organization and domain IDs. Requires 'organization:write' permission; no response body on success (204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this domain. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove member from organization by uuid

**Slug:** `POSTHOG_DELETE_ORGANIZATION_MEMBER`

Remove a member from a PostHog organization by their user UUID. This action is idempotent - calling it multiple times with the same parameters will always succeed without error, even if the member has already been removed or never existed. Use this to revoke a user's access to an organization, remove team members, or clean up organization memberships. The member will immediately lose access to all projects and data within the organization. API: DELETE /api/organizations/{organization_id}/members/{user_uuid}/ Returns: - HTTP 204: Member successfully removed - HTTP 404: Member not found (treated as success due to idempotent behavior) Requires: 'organization_member:write' permission Note: You cannot remove yourself from an organization using this action. To get user UUIDs, use the list_organization_members_with_pagination action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user__uuid` | string | Yes | UUID of the user to remove from the organization. You can get this from listing organization members. Note: This is the user's UUID, not the membership ID. |
| `organization_id` | string | Yes | UUID of the organization from which to remove the member. You can get this from the current user profile or by listing organizations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove organization pipeline destination

**Slug:** `POSTHOG_DELETE_ORGANIZATION_PIPELINE_DESTINATION`

Delete a specific pipeline destination in an organization by ID. Requires an integer 'id' of the destination, and the organization's 'uuid'. Auth: PersonalAPIKey with plugin:write. No return body on success (204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove org pipeline import app by id

**Slug:** `POSTHOG_DELETE_ORGANIZATION_PIPELINE_IMPORT_APP`

Delete a specific pipeline import app plugin associated with an organization by ID. Requires a personal API key with write permissions for plugins. Responds with no content on success (204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove organization pipeline transformation

**Slug:** `POSTHOG_DELETE_ORGANIZATION_PIPELINE_TRANSFORMATION`

Delete a specific pipeline transformation plugin for an organization by ID. Requires a UUID for the organization and an integer for the plugin. Auth: PersonalAPIKey with write access. No response body on success (204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove organization plugin by id

**Slug:** `POSTHOG_DELETE_ORGANIZATION_PLUGIN`

Delete a specific plugin (by its integer ID) from the organization (identified by UUID) with no response body on success. Requires plugin:write authorization via PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete organization project

**Slug:** `POSTHOG_DELETE_ORGANIZATION_PROJECT`

Projects for the current organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this team (soon to be environment). |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove organization proxy record

**Slug:** `POSTHOG_DELETE_ORGANIZATION_PROXY_RECORD`

Delete a proxy record by ID for a specific organization. Requires an authenticated user with 'organization:write' permission. On success, it responds with a 204 status and no content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove organization role by id

**Slug:** `POSTHOG_DELETE_ORGANIZATION_ROLE`

Delete a role with a specific UUID in an organization. Requires 'organization:write' permission. No response body on success (204). Path parameters include 'id' and 'organization_id'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this role. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete persisted folder

**Slug:** `POSTHOG_DELETE_PERSISTED_FOLDER`

Delete a persisted folder by providing its UUID and the associated project ID. Requires 'persisted_folder:write' permission. Returns no content with a 204 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this Persisted Folder. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete person and optionally associated events

**Slug:** `POSTHOG_DELETE_PERSON`

This endpoint is used to read and delete user data. Use the capture API, `$set`/`$unset` commands, or SDKs for creating/updating persons.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A unique UUID value identifying this person. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `delete_events` | boolean | No | If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday (controlled by environment variable CLEAR_CLICKHOUSE_REMOVED_DATA_SCHEDULE_CRON)  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete person property

**Slug:** `POSTHOG_DELETE_PERSON_PROPERTY`

Delete specific properties from a person record using the $unset operation. Use when you need to remove one or more properties from a person's profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A unique UUID value identifying this person. |
| `format` | string ("csv" | "json") | No | Response format (csv or json) |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `dollar_unset` | array | Yes | Array of property keys to delete from the person. Each string in the array represents a property name to remove. Example: ["$geoip_latitude", "$geoip_longitude"] |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete product tours

**Slug:** `POSTHOG_DELETE_PRODUCT_TOUR`

Delete a product tour by providing its UUID and the associated project ID. Requires 'product_tour:write' permission. Returns no content with a 204 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this product tour. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove specific project batch export

**Slug:** `POSTHOG_DELETE_PROJECT_BATCH_EXPORT`

Delete a specific batch export by providing the UUID and project ID. Requires a personal API key with 'batch_export:write' permissions. Responds with no body upon successful deletion (HTTP 204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this batch export. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove project dashboard collaborator

**Slug:** `POSTHOG_DELETE_PROJECT_DASHBOARD_COLLABORATOR`

Remove a collaborator from a project dashboard. Provide the project_id, dashboard_id, and user's UUID. Requires 'dashboard:write' permissions. Expect no response body on success (204). Project ID guidance at '/api/projects/'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `user__uuid` | string | Yes | User Uuid |
| `dashboard_id` | integer | Yes | Dashboard Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove early access feature from project

**Slug:** `POSTHOG_DELETE_PROJECT_EARLY_ACCESS_FEATURE`

Delete an early access feature by ID from a specified project. Requires a UUID for the feature and the project's ID. Authentication via PersonalAPIKeyAuth is necessary. No response body upon success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this early access feature. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove project event definition

**Slug:** `POSTHOG_DELETE_PROJECT_EVENT_DEFINITION`

Delete an event definition by providing its UUID and the associated project ID. Requires `event_definition:write` permission. Successful deletion returns no content (204 status).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this event definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove project experiment by id

**Slug:** `POSTHOG_DELETE_PROJECT_EXPERIMENT`

Soft-delete a specific experiment by its unique integer ID within a project. Uses PATCH to set the 'deleted' field to true since PostHog experiments do not support hard DELETE. Requires a Project ID and personal API key with experiment write permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment. |
| `deleted` | boolean | No | Set to true to soft-delete the experiment. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove explicit project member by uuid

**Slug:** `POSTHOG_DELETE_PROJECT_MEMBER`

Delete a specific user (by UUID) from the explicit members of a given project. Requires 'project_id' and member's 'parent_membership__user__uuid'. Returns 204 on success with no response body. Note: This endpoint only works for projects with access control enabled (private projects). Access control is an Enterprise feature. If the project does not have access control enabled, the API will return a 404 "Endpoint not found" error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint only works for projects with access control enabled (private projects). If the project does not have access control enabled, the API will return a 404 'Endpoint not found' error. |
| `parent__membership__user__uuid` | string | Yes | The UUID of the user to remove from the project's explicit members. This should be the user's UUID (from their user profile), not the membership ID. Use POSTHOG_LIST_ORGANIZATION_MEMBERS_WITH_PAGINATION to find user UUIDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove project plugin configuration

**Slug:** `POSTHOG_DELETE_PROJECT_PLUGIN_CONFIGURATION`

DELETE /api/projects/{project_id}/plugin_configs/{id}/: Removes a specific plugin configuration by ID from a given project. Requires 'plugin:write' permissions and project ID. Returns 204 with no body on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin config. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove specific project query

**Slug:** `POSTHOG_DELETE_PROJECT_QUERY`

(Experimental)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove property definition by uuid

**Slug:** `POSTHOG_DELETE_PROPERTY_DEFINITION`

Delete a property definition by providing its UUID and the associated project ID. Requires 'property_definition:write' permission. On success, no response body is returned (204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this property definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove rolemembership by uuid

**Slug:** `POSTHOG_DELETE_ROLE_MEMBERSHIP`

Remove a user from a custom organization role by deleting their role membership. This action permanently removes the specified user's membership in the role, revoking any permissions associated with that role. The operation is idempotent - attempting to remove a non-existent membership returns success. Use this action to: - Remove a user's access to a custom role - Revoke role-based permissions from a user - Clean up role memberships when users change responsibilities - Manage access control in your PostHog organization Requirements: - The organization must have access control enabled - You must have write permissions for the organization - The role must exist in the specified organization The action returns 204 No Content on successful deletion. Note that this removes the role membership but does not delete the user from the organization or the role itself.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier (UUID) of the role membership to remove. Use the list role memberships endpoint to get valid membership IDs for a specific role. |
| `role_id` | string | Yes | The unique identifier (UUID) of the role from which to remove the membership. Use the organization roles list endpoint to get valid role IDs. |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization containing the role. Use the organization list or details endpoints to get valid organization IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete session recording by uuid

**Slug:** `POSTHOG_DELETE_SESSION_RECORDING`

Delete a session recording by providing the session's UUID and the associated project ID. Requires `session_recording:write` permission. Returns no content on successful deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this session recording. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove session recording from playlist

**Slug:** `POSTHOG_DELETE_SESSION_RECORDING_FROM_PLAYLIST`

Remove a session recording from a playlist in a PostHog project. This action only removes the recording from the playlist - it does not delete the recording itself. The recording remains available in the project and can be re-added to playlists later. Requires project_id (get via /api/projects/), short_id (playlist identifier), and session_recording_id. Returns HTTP 204 on success. The operation is idempotent - removing a non-existent recording succeeds. Useful for curating playlists by removing irrelevant or accidentally added recordings. Works with 'collection' type playlists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `short_id` | string | Yes | The short identifier (short_id) of the session recording playlist from which to remove the recording. Obtain this from creating or listing session recording playlists. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `session_recording_id` | string | Yes | The unique identifier of the session recording to remove from the playlist. This must be a valid recording ID from an existing session recording in the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete survey by id

**Slug:** `POSTHOG_DELETE_SURVEY`

Delete a survey by providing its UUID and the associated project ID. Requires 'survey:write' permission. Returns no content with a 204 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete warehouse saved query

**Slug:** `POSTHOG_DELETE_WAREHOUSE_SAVED_QUERY`

Tool to delete a warehouse saved query from PostHog. Use when you need to remove a saved query from the data warehouse. The operation succeeds if the API returns 204 No Content status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this data warehouse saved query. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete web experiment

**Slug:** `POSTHOG_DELETE_WEB_EXPERIMENT`

Delete a web experiment by its ID from a specific project. Use when you need to permanently remove a web experiment. Requires 'experiment:write' scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this web experiment. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cohort duplication to static

**Slug:** `POSTHOG_DUPLICATE_COHORT_TO_STATIC`

This endpoint duplicates a specified cohort as a static one within a project. Path parameters include `project_id` (string) and cohort `id` (integer). Successful requests return cohort details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this cohort. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate experiment

**Slug:** `POSTHOG_DUPLICATE_EXPERIMENT`

Tool to duplicate an existing experiment in PostHog. Use when you need to create a copy of an experiment with the same configuration. The API automatically appends '(Copy)' to the duplicated experiment name and creates a new feature flag for it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying the experiment to duplicate. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate survey to projects

**Slug:** `POSTHOG_DUPLICATE_SURVEY_TO_PROJECTS`

Duplicate a survey to multiple projects in a single transaction. Accepts a list of target team IDs and creates a copy of the survey in each project. Uses an all-or-nothing approach - if any duplication fails, all changes are rolled back.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the survey to duplicate. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `target_team_ids` | array | Yes | A non-empty list of team IDs representing the target projects where the survey should be duplicated. All IDs must correspond to teams within the user's organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable project early access feature

**Slug:** `POSTHOG_ENABLE_PROJECT_EARLY_ACCESS_FEATURE`

Enables a new early access feature for a project using project ID, payload with details, and PersonalAPIKeyAuth. Returns a 201 status on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | Yes | Name |
| `stage` | string ("draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived") | Yes | * `draft` - draft * `concept` - concept * `alpha` - alpha * `beta` - beta * `general-availability` - general availability * `archived` - archived  |
| `created_at` | string | Yes | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `feature_flag_id` | integer | No | Feature Flag Id |
| `documentation_url` | string | No | Documentation Url |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Finish symbol sets bulk upload

**Slug:** `POSTHOG_FINISH_SYMBOL_SETS_BULK_UPLOAD`

Tool to finalize bulk upload of error tracking symbol sets for a PostHog project. Use when completing a multi-part symbol set upload process. This endpoint marks the upload as complete and makes the symbol sets available for error stack trace symbolication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier for the symbol set in UUID format |
| `ref` | string | Yes | Reference identifier (e.g., git branch or commit reference) |
| `release` | string | Yes | Release version identifier for the symbol set |
| `team_id` | integer | Yes | Team ID associated with the symbol set (same as project_id in most contexts) |
| `last_used` | string | No | Optional ISO 8601 timestamp when the symbol set was last used |
| `created_at` | string | Yes | ISO 8601 timestamp when the symbol set was created (e.g., '2024-01-01T00:00:00Z') |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `storage_ptr` | string | No | Optional storage pointer referencing where the symbol set data is stored |
| `failure_reason` | string | No | Optional reason for failure if the symbol set upload or processing failed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Flag annotation as deleted

**Slug:** `POSTHOG_FLAG_ANNOTATION_AS_DELETED`

Soft delete an annotation by setting 'deleted' to true via PATCH request. Hard delete of this model is not allowed by the API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this annotation. |
| `deleted` | boolean | No | Set to true to mark the annotation as deleted (soft delete). |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Insight Name

**Slug:** `POSTHOG_GENERATE_INSIGHT_NAME`

Tool to generate an AI-suggested name for a PostHog insight based on its query configuration. Use when you need to automatically name an insight instead of manually creating a descriptive title.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | object | Yes | Query configuration object for the insight. Must include 'kind' (e.g., 'InsightVizNode') and 'source' with query details like TrendsQuery, FunnelsQuery, etc. |
| `format` | string | No | Response format. Options: 'json' (default) or 'csv'. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate project funnel correlation insight

**Slug:** `POSTHOG_GENERATE_PROJECT_FUNNEL_CORRELATION_INSIGHT`

The /api/projects/{project_id}/insights/funnel/correlation endpoint generates a correlation insight for funnel analysis in a project, accepting JSON/CSV and needing 'project_id' and insight details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | No | Events to filter on. One of `events` or `actions` is required. |
| `format` | string ("csv" | "json") | No | Format |
| `actions` | array | No | Actions to filter on. One of `events` or `actions` is required. |
| `date_to` | string | No | What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.  |
| `insight` | string | No | Type of insight. For funnel correlation, should be 'FUNNELS'. |
| `breakdown` | string | No | A property or cohort to break down on. You can select the type of the property with breakdown_type. - `event` (default): a property key - `person`: a person property key - `cohort`: an array of cohort IDs (ie `[9581,5812]`)  |
| `date_from` | string | No | What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.  |
| `exclusions` | array | No | Exclude users/groups that completed the specified event between two specific steps. Note that these users/groups will be completely excluded from the entire funnel.  |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | string | No | Properties to filter on. |
| `breakdown_type` | string | No | The type of breakdown. |
| `funnel_viz_type` | string | No | Funnel visualization type. |
| `funnel_order_type` | string | No | Funnel order type. |
| `filter_test_accounts` | boolean | No | Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.  |
| `funnel_window_interval` | integer | No | Funnel window size. Set in combination with funnel_window_interval_type, so defaults to "days".  |
| `funnel_correlation_type` | string ("events" | "properties" | "event_with_properties") | No | Type of correlation to analyze: 'events', 'properties', or 'event_with_properties'. |
| `funnel_correlation_names` | array | No | Names of events or properties to correlate. |
| `funnel_window_interval_type` | string | No | Funnel window interval type. Can be 'day', 'week', or 'month'. |
| `aggregation_group_type_index` | integer | No | Aggregate by users or by groups. `0` means user, `>0` means a group. See interface for the corresponding ID of the group.  |
| `funnel_correlation_exclude_names` | array | No | Names of events or properties to exclude from correlation. |
| `funnel_correlation_person_entity` | object | No | Person entity configuration for correlation. |
| `funnel_correlation_person_converted` | string | No | Filter for converted persons. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve app metrics by ids

**Slug:** `POSTHOG_GET_APP_METRICS`

Retrieve performance and error metrics for a specific plugin configuration (app) in a PostHog project. This action returns time-series data showing the success rate, failures, and retry statistics for a plugin configuration over the last 31 days. Use this to monitor the health and performance of installed apps/plugins in your PostHog project. The metrics include: - Daily counts of successful executions - Daily counts of executions that succeeded after retrying - Daily counts of failed executions - Aggregated totals across the time period - Error details (if any errors occurred) To find available plugin configuration IDs, first call the list_project_plugin_configurations action. Requires a personal API key with plugin:read access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The plugin configuration ID for which to retrieve app metrics. Plugin configs represent installed apps/plugins in PostHog. To find available plugin config IDs, use the list_project_plugin_configurations action. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve app metrics error details

**Slug:** `POSTHOG_GET_APP_METRICS_ERROR_DETAILS`

Retrieves detailed error information for a specific app metric (plugin config) within a project. This endpoint provides error details for plugins/apps that have experienced failures. If the plugin config has no recorded errors, the API returns a 403 Forbidden response. To check if errors exist before calling this endpoint, use the base app_metrics endpoint which shows error counts. Parameters: - project_id: The ID of the project containing the plugin config - id: The plugin config ID (integer) for which to retrieve error details Note: This endpoint only returns data when errors have been recorded for the specified plugin config. Check the failures count in the base app_metrics endpoint first to determine if error details are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Plugin config ID (app metric ID) for which to retrieve error details. This is the unique integer identifier of a plugin configuration. Use the list_project_plugin_configurations action to find valid IDs. |
| `project_id` | string | Yes | Project ID of the project containing the plugin config. To find the ID of a project, use the list_all_projects_across_organizations action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve batch export details

**Slug:** `POSTHOG_GET_BATCH_EXPORT_DETAILS`

Retrieve details of a specific batch export by its UUID in a project. Requires project_id and batch export ID. Supports PersonalAPIKeyAuth and responds with export details including destination, interval, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this batch export. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get batch exports backfills

**Slug:** `POSTHOG_GET_BATCH_EXPORTS_BACKFILLS`

Tool to retrieve backfills for a specific batch export within a project. Use when you need to view historical backfill operations for batch exports. Supports pagination via cursor and custom ordering of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | The pagination cursor value. |
| `ordering` | string | No | Which field to use when ordering the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `batch_export_id` | string | Yes | The BatchExport this backfill belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve cohort activity details

**Slug:** `POSTHOG_GET_COHORT_ACTIVITY_DETAILS`

Retrieve activity details for a specific cohort within a project. Requires a project ID and cohort ID, returning status, filters, query, and creator data. Auth: PersonalAPIKeyAuth with 'activity_log:read' scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this cohort. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve cohort person details

**Slug:** `POSTHOG_GET_COHORT_PERSON_DETAILS`

Retrieve details of persons within a cohort by its unique ID in the specified project. The endpoint supports JSON and CSV formats and requires authorization. Project and cohort IDs must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this cohort. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get cohort calculation history

**Slug:** `POSTHOG_GET_COHORTS_CALCULATION_HISTORY`

Tool to retrieve the calculation history for a specific cohort. Use when you need to track cohort recalculations, monitor calculation performance, or debug calculation errors. Returns paginated list of historical calculations with timing metrics and success status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this cohort. |
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get conversation

**Slug:** `POSTHOG_GET_CONVERSATION`

Tool to retrieve a specific conversation by UUID and project ID. Use when you need to access conversation details including messages, status, and associated user information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `conversation` | string | Yes | A UUID string identifying this conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get conversations

**Slug:** `POSTHOG_GET_CONVERSATIONS`

Tool to retrieve conversations for a specific PostHog project with pagination support. Use when you need to fetch conversation data including messages, status, and user information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Profile Config

**Slug:** `POSTHOG_GET_CUSTOMER_PROFILE_CONFIG`

Retrieve a specific customer profile configuration by its ID for a given project. Use when you need to fetch details about how customer profiles are configured for persons or groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this customer profile config. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get customer profile configs

**Slug:** `POSTHOG_GET_CUSTOMER_PROFILE_CONFIGS`

Tool to retrieve customer profile configurations for a project with pagination support. Use when you need to list or access customer profile configuration settings for a specific PostHog project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve dashboard template details by uuid

**Slug:** `POSTHOG_GET_DASHBOARD_TEMPLATE_DETAILS`

Fetch specific dashboard template details by UUID in a project with 'dashboard_template:read' rights using a PersonalAPIKeyAuth. Returns name, description, filters, and creation info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this dashboard template. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve dashboard template schema

**Slug:** `POSTHOG_GET_DASHBOARD_TEMPLATE_SCHEMA`

Retrieve the JSON schema for dashboard templates of a specific project. Pass the project_id in the path and receive details such as template name, description, filters, and more. Supports GET requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get data color theme

**Slug:** `POSTHOG_GET_DATA_COLOR_THEME`

Tool to retrieve a specific data color theme by ID from a PostHog project. Use when you need to fetch theme configuration details for data visualization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this data color theme. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Color Themes

**Slug:** `POSTHOG_GET_DATA_COLOR_THEMES`

Tool to retrieve data color themes for a specific project. Use when you need to list available color themes for data visualization. Returns paginated results with theme details including colors, creator information, and global status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get dataset details

**Slug:** `POSTHOG_GET_DATASET`

Retrieve detailed information about a specific dataset within a project. Use this to get dataset properties including name, description, creator info, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this dataset. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dataset Item

**Slug:** `POSTHOG_GET_DATASET_ITEM`

Tool to retrieve a specific dataset item by its ID from a PostHog project. Use when you need to fetch details about a particular dataset item including its input, output, metadata, and creation information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this dataset item. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get dataset items

**Slug:** `POSTHOG_GET_DATASET_ITEMS`

Tool to retrieve paginated dataset items for a specific project in PostHog. Use when you need to list or explore dataset items with optional filtering by dataset ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `dataset` | string | No | Filter by dataset ID |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Datasets

**Slug:** `POSTHOG_GET_DATASETS`

Tool to retrieve datasets for a PostHog project. Use when you need to list or search datasets within a specific project. Supports filtering by IDs, searching by name/description, and ordering results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `id__in` | array | No | Filter datasets by IDs. Multiple values may be separated by commas. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | Search in name, description, or metadata |
| `order_by` | array | No | Ordering. Options: 'created_at', '-created_at' (descending), 'updated_at', '-updated_at' (descending) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get desktop recordings

**Slug:** `POSTHOG_GET_DESKTOP_RECORDINGS`

Tool to retrieve desktop meeting recordings for a specific project. Use when you need to access recorded meetings with transcripts, summaries, and extracted tasks. Returns paginated results with support for limit and offset parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Endpoint OpenAPI Specification

**Slug:** `POSTHOG_GET_ENDPOINT_OPENAPI_SPECIFICATION`

Get OpenAPI 3.0 specification for a specific PostHog endpoint. Use this to generate typed SDK clients. Returns the complete OpenAPI schema including paths, components, and security definitions for the specified endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | URL-safe name for the endpoint |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking assignment rules

**Slug:** `POSTHOG_GET_ERROR_TRACKING_ASSIGNMENT_RULES`

Tool to retrieve error tracking assignment rules for a project. Use when you need to list the configured rules that automatically assign error tracking issues to team members based on filters. Supports pagination via limit and offset parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking autocapture control

**Slug:** `POSTHOG_GET_ERROR_TRACKING_AUTOCAPTURE_CONTROL`

Retrieve a specific error tracking autocapture control configuration by its ID. Use this to view detailed settings for a particular autocapture control including sample rates, URL triggers, and event filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking auto capture controls. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking fingerprints

**Slug:** `POSTHOG_GET_ERROR_TRACKING_FINGERPRINTS`

Tool to retrieve error tracking fingerprints for a project. Use when you need to list tracked errors with their status, occurrence counts, and timing information. Returns paginated list of error fingerprints that group similar errors together for easier tracking and resolution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking grouping rules

**Slug:** `POSTHOG_GET_ERROR_TRACKING_GROUPING_RULES`

Tool to retrieve error tracking grouping rules for a project. Use when you need to list the configured rules that control how error tracking issues are grouped together based on filters. Supports pagination via limit and offset parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking release

**Slug:** `POSTHOG_GET_ERROR_TRACKING_RELEASE`

Retrieve details of a specific error tracking release by its UUID and project ID. Use when you need to fetch information about a particular release in error tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking release. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking release by hash

**Slug:** `POSTHOG_GET_ERROR_TRACKING_RELEASE_BY_HASH`

Tool to retrieve an error tracking release by its hash identifier. Use when you need to fetch release details using a hash ID instead of the UUID. Requires 'error_tracking:read' scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hash_id` | string | Yes | The hash identifier of the error tracking release to retrieve. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking releases

**Slug:** `POSTHOG_GET_ERROR_TRACKING_RELEASES`

Tool to retrieve paginated error tracking releases for a specific project in PostHog. Use when you need to list releases associated with error tracking to identify version-specific issues.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking suppression rules

**Slug:** `POSTHOG_GET_ERROR_TRACKING_SUPPRESSION_RULES`

Tool to retrieve error tracking suppression rules for a project. Use when you need to list the configured rules that automatically suppress specific error tracking issues based on filters. Supports pagination via limit and offset parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get error tracking symbol sets

**Slug:** `POSTHOG_GET_ERROR_TRACKING_SYMBOL_SETS`

Tool to retrieve error tracking symbol sets for a PostHog project. Use when you need to list symbol sets used for error stack trace symbolication. Returns paginated list of symbol sets including their references, release versions, and processing status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Evaluation

**Slug:** `POSTHOG_GET_EVALUATION`

Retrieve details of a specific evaluation by its UUID and project ID. Use this to fetch evaluation configuration, type, conditions, and associated model settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this evaluation. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get evaluations for project

**Slug:** `POSTHOG_GET_EVALUATIONS`

Tool to retrieve evaluations configured for a specific PostHog environment/project. Use when you need to list AI model evaluations, check their configurations, or filter evaluations by status or search terms. Returns paginated list of evaluations with their types, configurations, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id_in` | array | No | Filter by evaluation IDs. Multiple values may be separated by commas. |
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | Search in name or description |
| `enabled` | boolean | No | Filter by enabled status |
| `order_by` | array | No | Ordering. Multiple values may be specified for multi-level ordering. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve event definition by uuid

**Slug:** `POSTHOG_GET_EVENT_DEFINITION`

Retrieve an event definition by its UUID within a specified project. Requires a project_id and an event definition ID, with access secured by PersonalAPIKeyAuth. (GET /api/projects/{project_id}/event_definitions/{id})

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this event definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get event definition by name

**Slug:** `POSTHOG_GET_EVENT_DEFINITION_BY_NAME`

Tool to retrieve an event definition by its exact name for a specific project. Use when you need to look up details about a specific event by name rather than UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The exact event name to look up (e.g., '$pageview', '$groupidentify', 'user_signed_up') |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve event definitions by project id

**Slug:** `POSTHOG_GET_EVENT_DEFINITIONS`

Retrieve definitions for events within a specified project by providing the unique project_id. Requires PersonalAPIKeyAuth privileges for event_definition:read. No response body provided upon a successful call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get event definitions in Golang format

**Slug:** `POSTHOG_GET_EVENT_DEFINITIONS_GOLANG`

Tool to retrieve event definitions in Golang format for a specific PostHog project. Use when you need Golang code generation or type definitions for events in the specified project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get event definitions in Python format

**Slug:** `POSTHOG_GET_EVENT_DEFINITIONS_PYTHON`

Tool to retrieve Python-formatted event definitions for a specific project. Use when you need to access event definitions in Python format for code generation or SDK integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get event definitions TypeScript

**Slug:** `POSTHOG_GET_EVENT_DEFINITIONS_TYPESCRIPT`

Tool to retrieve TypeScript event definitions for a specific project. Use when you need to generate type-safe event definitions for TypeScript applications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve experiment details by ids

**Slug:** `POSTHOG_GET_EXPERIMENT_DETAILS`

Access detailed experiment info within a project using unique `experiment ID` & `project ID`, with 'experiment:read' rights. Response includes dates, feature flag key, metrics, creator details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get experiment holdout details

**Slug:** `POSTHOG_GET_EXPERIMENT_HOLDOUT_DETAILS`

Retrieve details of a specific experiment holdout by ID within a project. Use this to get information about an experiment holdout including its name, description, filters, and creation details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment holdout. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get experiment holdouts

**Slug:** `POSTHOG_GET_EXPERIMENT_HOLDOUTS`

Tool to retrieve experiment holdouts for a specific PostHog project. Use when you need to view holdout groups for experiments. Returns paginated list of holdouts with their configurations and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get experiment saved metric

**Slug:** `POSTHOG_GET_EXPERIMENT_SAVED_METRIC`

Tool to retrieve a specific experiment saved metric by ID from a PostHog project. Use when you need to fetch details about a saved metric configuration for experiments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment saved metric. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get eligible feature flags for experiments

**Slug:** `POSTHOG_GET_EXPERIMENTS_ELIGIBLE_FEATURE_FLAGS`

Tool to retrieve feature flags eligible for use in experiments. Use when you need to find multivariate feature flags that can be used to run A/B tests. Only returns flags with at least 2 variants where the first variant key is 'control'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `order` | string | No | Field name to sort results by. Prefix with '-' for descending order. |
| `active` | string | No | Filter by active status. Must be 'true' or 'false' as a string. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | Filter by feature flag key or name (case insensitive search). |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `created_by_id` | integer | No | Filter feature flags by the ID of the user who created them. |
| `evaluation_runtime` | string | No | Filter by feature flag evaluation runtime. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve experiments requiring flag implementation

**Slug:** `POSTHOG_GET_EXPERIMENTS_REQUIRING_FLAG_IMPLEMENTATION`

Retrieve details for experiments that require feature flag implementation in a specific project. Requires a valid 'project_id' and user must have 'experiment:read' permission. Returns information like experiment names, dates, flags, and creation data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get experiments stats

**Slug:** `POSTHOG_GET_EXPERIMENTS_STATS`

Tool to retrieve experimentation velocity statistics for a PostHog project. Use when you need to understand overall experiment activity and distribution. Returns high-level statistics including total, running, completed, and draft experiment counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve export unsubscribe configs

**Slug:** `POSTHOG_GET_EXPORT_UNSUBSCRIBE_CONFIGS`

Retrieves export unsubscribe configurations for pipeline import apps in an organization. This endpoint returns a list of configurations that define how users can unsubscribe from various pipeline import app exports. Each configuration includes an ID, plugin type identifier, and configuration settings. Use case: Check which export import apps support unsubscribe functionality and their configuration details. This is useful for managing data export preferences and compliance requirements. Note: This endpoint may require specific organization permissions or enterprise features. If you receive a 403 Forbidden error, the organization may not have access to pipeline import apps or this specific feature may not be enabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The UUID of the organization to retrieve export unsubscribe configurations for (e.g., '019c0f24-2413-0000-bbbc-d276c57e0dbb'). Use POSTHOG_FETCH_ORGANIZATION_DETAILS_BY_UUID or POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to get valid organization IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch export unsubscribe settings

**Slug:** `POSTHOG_GET_EXPORT_UNSUBSCRIBE_SETTINGS`

Retrieves export unsubscribe configurations for pipeline transformations in an organization. This endpoint returns a list of configurations that define how users can unsubscribe from various pipeline transformation exports. Each configuration includes an ID, plugin type identifier, and configuration settings. Use case: Check which export transformations support unsubscribe functionality and their configuration details. This is useful for managing data export preferences and compliance requirements. Note: This endpoint may require specific organization permissions or enterprise features. If you receive a 403 Forbidden error, the organization may not have access to this feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The UUID of the organization to retrieve export unsubscribe configurations for (e.g., '019c0f24-2413-0000-bbbc-d276c57e0dbb'). Use LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATION or similar actions to get valid organization IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get external data source

**Slug:** `POSTHOG_GET_EXTERNAL_DATA_SOURCE`

Tool to retrieve details of a specific external data source by its UUID and project ID. Use when you need to access external data source configuration, status, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this external data source. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get external data sources

**Slug:** `POSTHOG_GET_EXTERNAL_DATA_SOURCES`

Tool to retrieve external data sources for a PostHog project with pagination support. Use when you need to list or search for configured external data connections like Stripe, Postgres, or Snowflake.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | A search term to filter external data sources. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve feature flag activity details

**Slug:** `POSTHOG_GET_FEATURE_FLAG_ACTIVITY_DETAILS`

Manage feature flags (creation, reading, updating, and deleting) using PostHog's guides or via JavaScript Library/endpoint for user-specific flag status. [Details](https://posthog.com/docs/user-guides/feature-flags)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve feature flag details

**Slug:** `POSTHOG_GET_FEATURE_FLAG_DETAILS`

Retrieve detailed information about a specific feature flag in a PostHog project. This action fetches comprehensive details including: - Basic information (id, name, key) - Filter configuration and rollout percentages - Status (active, deleted) - Creator and modification history - Associated experiments, surveys, and features - Analytics and dashboard configurations - Access control and permissions - Tags and metadata Use this to inspect feature flag configuration, check status, or gather information before making updates. Requires a valid project_id and feature flag id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve feature flag role access details

**Slug:** `POSTHOG_GET_FEATURE_FLAG_ROLE_ACCESS_DETAILS`

Retrieve details for a specific role's access to a feature flag within a project. Requires 'feature_flag_id', 'id' for role access, and 'project_id'. Returns a JSON object with access details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag role access. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `feature_flag_id` | integer | Yes | Feature Flag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve feature flags activity log

**Slug:** `POSTHOG_GET_FEATURE_FLAGS_ACTIVITY_LOG`

Learn to manage feature flags by creating, reading, updating, and deleting them. Use PostHog's JavaScript Library or endpoint for application integration. Details in the [docs](https://posthog.com/docs/user-guides/feature-flags).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get feature flags dependent flags

**Slug:** `POSTHOG_GET_FEATURE_FLAGS_DEPENDENT_FLAGS`

Retrieve all active feature flags that depend on a specified flag. Use when you need to understand flag dependencies before modifying or deleting a flag. Helps prevent breaking dependent flags by showing which flags reference the target flag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve feature flags evaluation reasons

**Slug:** `POSTHOG_GET_FEATURE_FLAGS_EVALUATION_REASONS`

Manage feature flags—create, read, update, delete—using the PostHog JavaScript Library or endpoint for user-specific flag status. (More in docs).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `distinct_id` | string | Yes | The distinct ID of the user for whom to evaluate feature flags. This is used to determine which feature flags are enabled for the specific user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get feature flags matching IDs

**Slug:** `POSTHOG_GET_FEATURE_FLAGS_MATCHING_IDS`

Tool to get IDs of all feature flags matching the current filters. Uses the same filtering logic as the list endpoint and returns only IDs that the user has permission to edit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get feature flag status

**Slug:** `POSTHOG_GET_FEATURE_FLAG_STATUS`

Tool to retrieve the status of a specific feature flag in a PostHog project. Use when you need to check the operational status or state of a feature flag beyond its basic configuration details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get file system

**Slug:** `POSTHOG_GET_FILE_SYSTEM`

Tool to retrieve a specific file system resource by UUID and project ID. Use when you need to access details about a file system in PostHog, including metadata and path information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this file system. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get file system shortcut

**Slug:** `POSTHOG_GET_FILE_SYSTEM_SHORTCUT`

Retrieve a specific file system shortcut by UUID from a project. Requires 'file_system_shortcut:read' permission. Returns detailed information about the shortcut including path, type, and creation timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this file system shortcut. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve filtered project property definitions

**Slug:** `POSTHOG_GET_FILTERED_PROJECT_PROPERTY_DEFINITIONS`

Get property definitions for a project using project_id, with filters for event names, property types, exclusions, and numerical or feature flags. Also, view properties relevant to specific events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("event" | "person" | "group" | "session") | No | What property definitions to return * `event` - event * `person` - person * `group` - group * `session` - session  |
| `search` | string | No | Searches properties by name |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | string | No | Comma-separated list of properties to filter |
| `event_names` | string | No | If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded  |
| `is_numerical` | boolean | No | Whether to return only (or excluding) numerical property definitions |
| `is_feature_flag` | boolean | No | Whether to return only (or excluding) feature flag properties |
| `group_type_index` | integer | No | What group type is the property for. Only should be set if `type=group` |
| `excluded_properties` | string | No | JSON-encoded list of excluded properties |
| `filter_by_event_names` | boolean | No | Whether to return only properties for events in `event_names` |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve funnel insights in project

**Slug:** `POSTHOG_GET_FUNNEL_INSIGHTS_IN_PROJECT`

Execute a funnel analysis for a specific project. Requires specifying funnel steps via 'events' or 'actions' parameter (at least 2 steps). Returns conversion data showing how users progress through the funnel. Supports JSON/CSV output formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | No | List of events to include in the funnel. Each event should have 'id' (event name), 'type' ('events'), and 'order' (step number starting from 0). At least 2 steps are required. One of 'events' or 'actions' is required. |
| `format` | string ("json" | "csv") | No | Response format: 'json' or 'csv'. |
| `actions` | array | No | List of actions to include in the funnel. Each action should have 'id' (action ID), 'type' ('actions'), and 'order' (step number). One of 'events' or 'actions' is required. |
| `date_to` | string | No | End date for the funnel analysis. Can be a date '2021-01-01' or relative like '-7d', '-1m', 'mStart', 'yStart'. |
| `date_from` | string | No | Start date for the funnel analysis. Can be a date '2021-01-01' or relative like '-7d', '-1m', 'mStart', 'yStart'. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `filter_test_accounts` | boolean | No | Whether to filter out internal and test accounts. |
| `funnel_window_interval` | integer | No | Funnel conversion window size (used with funnel_window_interval_type). |
| `funnel_window_interval_type` | string | No | Unit for funnel window interval: 'day', 'hour', 'minute', 'week', or 'month'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve group property definitions by project id

**Slug:** `POSTHOG_GET_GROUP_PROPERTY_DEFINITIONS`

Retrieve property definitions for a group within a project by providing the project ID. This endpoint returns details like group type index, key, and creation time in JSON format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve group property values by index and key

**Slug:** `POSTHOG_GET_GROUP_PROPERTY_VALUES`

Retrieve property values by 'group_type_index' and 'key' within a 'project_id'. Parameters must be provided. Output is a JSON with property details and creation timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Specify the property key to find values for |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `group_type_index` | integer | Yes | Specify the group type to find property values of |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get group type metric by ID

**Slug:** `POSTHOG_GET_GROUPS_TYPES_METRIC_BY_ID`

Tool to retrieve detailed information about a specific group usage metric by its ID. Use when you need to get the configuration, filters, display format, and calculation interval for a particular metric within a group type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this group usage metric |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `group_type_index` | integer | Yes | Numerical identifier for the group type (e.g., 0, 1, 2). Used to differentiate between different types of groups such as companies, projects, or teams. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get groups types metrics

**Slug:** `POSTHOG_GET_GROUPS_TYPES_METRICS`

Tool to retrieve metrics for a specific group type in a PostHog project. Use when you need to list all metrics associated with a particular group type index. Returns paginated results with metric configurations including filters, display settings, and formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `group_type_index` | integer | Yes | Numerical identifier for the group type (e.g., 0, 1, 2). Used to differentiate between different types of groups such as companies, projects, or teams. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve hedgehog configuration by uuid

**Slug:** `POSTHOG_GET_HEDGEHOG_CONFIGURATION`

Retrieve user's hedgehog configuration details by their UUID. This endpoint returns hedgehog-related settings (PostHog's mascot customization) for a user. Use '@me' as the uuid parameter to reference the current user. IMPORTANT: This endpoint does NOT support Personal API Key authentication. It requires session-based authentication (browser login) and will return a 403 "permission_denied" error with message "This action does not support Personal API Key access" when called with an API key. This is a limitation of the PostHog API, not the action implementation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uuid` | string | Yes | The user identifier. Use '@me' to retrieve the current authenticated user's hedgehog configuration (recommended). Note: This endpoint does NOT support Personal API Key access - it requires session-based authentication (browser login). Calling this endpoint with an API key will result in a 403 permission_denied error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve historical app metrics export

**Slug:** `POSTHOG_GET_HISTORICAL_APP_METRICS_EXPORT`

Retrieve historical export data for app metrics by supplying the `project_id` and `plugin_config_id`. Requires `plugin:read` permission. No response body provided upon a successful request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `plugin_config_id` | string | Yes | Plugin Config Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get hog function

**Slug:** `POSTHOG_GET_HOG_FUNCTION`

Tool to retrieve a specific hog function by UUID and project ID. Use when you need to access details about a hog function including its configuration, code, filters, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this hog function. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get hog functions

**Slug:** `POSTHOG_GET_HOG_FUNCTIONS`

Tool to retrieve hog functions for a specific PostHog project. Use when you need to list, search, or filter hog functions with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Filter hog functions by ID |
| `type` | array | No | Filter hog functions by type. Multiple values may be provided as a list |
| `limit` | integer | No | Number of results to return per page |
| `offset` | integer | No | The initial index from which to return the results |
| `search` | string | No | A search term to filter hog functions |
| `enabled` | boolean | No | Filter hog functions by enabled status |
| `created_at` | string | No | Filter hog functions by creation date |
| `created_by` | integer | No | Filter hog functions by creator user ID |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `updated_at` | string | No | Filter hog functions by last update date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve important project activity log

**Slug:** `POSTHOG_GET_IMPORTANT_PROJECT_ACTIVITY_LOG`

Retrieve a log of important activities and changes for a specified project. This endpoint returns significant project events including creation, updates, and deletions of resources like dashboards, feature flags, insights, session recording playlists, tags, and other key entities. Each entry includes the activity type, affected item details, user information (if user-initiated), timestamps, and a detailed change log. System-generated activities are also included. Results are paginated and ordered by most recent first. Requires a `project_id`. Use the LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS action to obtain available project IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Numeric project ID (e.g., '12345'). Must be an integer ID, not a project name or slug. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve insight sharing configurations

**Slug:** `POSTHOG_GET_INSIGHT_SHARING_CONFIGURATIONS`

Retrieve sharing configurations for a specific insight within a project, requiring project and insight IDs. Validates access via PersonalAPIKeyAuth. Returns data such as creation time and access tokens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `insight_id` | integer | Yes | Insight Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get insight thresholds

**Slug:** `POSTHOG_GET_INSIGHTS_THRESHOLDS`

Tool to retrieve thresholds configured for a specific insight within a project. Use when you need to view alert thresholds or monitoring criteria set up for an insight. Returns paginated list of thresholds with their configurations and associated alerts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `insight_id` | integer | Yes | Unique integer identifier for the insight whose thresholds you want to retrieve. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get insight threshold

**Slug:** `POSTHOG_GET_INSIGHT_THRESHOLD`

Tool to retrieve a specific insight threshold by ID for a PostHog project. Use when you need to view threshold configuration, bounds, and associated alerts for monitoring insights.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this threshold. |
| `insight_id` | integer | Yes | ID of the insight to retrieve threshold for |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get insight variable

**Slug:** `POSTHOG_GET_INSIGHT_VARIABLE`

Tool to retrieve a specific insight variable by UUID and project ID. Use when you need to access details about an insight variable including its type, name, and values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this insight variable. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get insight variables

**Slug:** `POSTHOG_GET_INSIGHT_VARIABLES`

Tool to retrieve paginated list of insight variables for a project. Use when you need to discover available variables for insights or query their configurations. Returns variables with their types, default values, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | A page number within the paginated result set. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get live debugger breakpoint

**Slug:** `POSTHOG_GET_LIVE_DEBUGGER_BREAKPOINT`

Tool to retrieve a specific live debugger breakpoint by UUID and project ID. Use when you need to fetch details about a breakpoint for live debugging.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this live debugger breakpoint. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get live debugger breakpoints

**Slug:** `POSTHOG_GET_LIVE_DEBUGGER_BREAKPOINTS`

Tool to retrieve live debugger breakpoints for a project. Returns a paginated list of breakpoints with their configuration including filename, line number, condition, and status. Use when you need to list or inspect existing breakpoints for live debugging.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page |
| `offset` | integer | No | The initial index from which to return the results |
| `filename` | string | No | Filter breakpoints by filename |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `repository` | string | No | Filter breakpoints by repository |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LLM Analytics Evaluation Config

**Slug:** `POSTHOG_GET_LLM_ANALYTICS_EVALUATION_CONFIG`

Tool to retrieve the LLM analytics evaluation configuration for a specific PostHog project. Use when you need to check evaluation settings, trial limits, or usage statistics for LLM analytics features.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LLM Analytics Models

**Slug:** `POSTHOG_GET_LLM_ANALYTICS_MODELS`

Tool to list available LLM models for a specific provider in PostHog LLM Analytics. Use when you need to discover which models are available for a given provider (e.g., openai, anthropic).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider` | string | Yes | LLM provider name (e.g., openai, anthropic) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LLM Analytics Provider Keys

**Slug:** `POSTHOG_GET_LLM_ANALYTICS_PROVIDER_KEYS`

Tool to retrieve LLM analytics provider keys for a project. Use when you need to list API keys configured for LLM analytics providers. Returns paginated results with provider key details including masked keys, usage timestamps, and provider information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get logs attributes

**Slug:** `POSTHOG_GET_LOGS_ATTRIBUTES`

Tool to retrieve available log attributes for a PostHog project. Use when you need to discover what log attribute fields are available for querying or filtering logs. Requires the logs:read scope and returns metadata about log attributes that can be used in log queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get logs availability status

**Slug:** `POSTHOG_GET_LOGS_HAS_LOGS`

Tool to check if a project has logs available. Use when you need to verify log availability before querying logs. Returns a boolean indicator of log presence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get log field values

**Slug:** `POSTHOG_GET_LOGS_VALUES`

Tool to retrieve unique values for a specific log field key in a PostHog project. Use when you need to discover available values for log fields like level, message, source, or other log properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | The log field key to retrieve values for (e.g., 'level', 'message', 'source', 'timestamp'). This parameter is required. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch organization details by uuid

**Slug:** `POSTHOG_GET_ORGANIZATION`

Retrieve organization details by UUID. Endpoint requires 'organization:read' access. Response includes name, slug, timestamps, membership, plugins access level, and team structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch organization pipeline app repositories

**Slug:** `POSTHOG_GET_ORGANIZATION_PIPELINE_APP_REPOSITORIES`

Retrieve details of pipeline import app repositories for a specific organization by its UUID. Returns JSON with properties like plugin type, name, and URL. Supports 'local', 'custom', 'repository', 'source', 'inline' types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get persisted folders

**Slug:** `POSTHOG_GET_PERSISTED_FOLDER`

Tool to list persisted folders for a PostHog project with pagination support. Use when you need to retrieve or browse persisted folder configurations within a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch pipeline destination activity

**Slug:** `POSTHOG_GET_PIPELINE_DESTINATION_DETAILS`

Retrieve activity logs and metadata for a specific pipeline destination configuration. Returns activity information including latest updates, version tags, and operational status. Use this to monitor the activity and update history of a destination config. For complete destination config details (plugin settings, filters, enabled status), use POSTHOG_RETRIEVE_PIPELINE_DESTINATION_CONFIG_DETAILS instead. Required: project_id (integer) and destination config id (integer).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique integer ID of the pipeline destination config. Get this from POSTHOG_LIST_PIPELINE_DESTINATION_CONFIGS_WITH_PAGINATION. |
| `project_id` | string | Yes | Project ID of the project (integer as string, e.g., '302160'). Get this from POSTHOG_LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATION. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch pipeline transformation details

**Slug:** `POSTHOG_GET_PIPELINE_TRANSFORMATION_DETAILS`

Retrieve available pipeline transformation plugins from the organization's plugin repository. Returns a list of transformation templates that can be used to modify, enrich, or filter events in real-time. Each plugin includes configuration schemas, capabilities, and metadata. Requires `organization_id` (organization UUID). Note: This endpoint requires specific authentication permissions beyond Personal API Keys and may not be accessible in all environments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get product tour

**Slug:** `POSTHOG_GET_PRODUCT_TOUR`

Tool to retrieve a specific product tour by UUID from a PostHog project. Use when you need to fetch details about a product tour configuration, including targeting and content settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this product tour. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve and delete project person trends

**Slug:** `POSTHOG_GET_PROJECT_PERSON_TRENDS`

This endpoint is for reading and deleting persons. Use the capture API, `$set`/`$unset` properties, or SDKs for creating/updating persons.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch project survey activity log

**Slug:** `POSTHOG_GET_PROJECT_SURVEY_ACTIVITY_LOG`

Retrieve the activity log of surveys within a specific project by using the project ID. This endpoint requires a PersonalAPIKeyAuth with 'activity_log:read' permission and returns survey details including types, flags, questions, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Role Membership

**Slug:** `POSTHOG_GET_ROLE_MEMBERSHIP`

Retrieve details of a specific role membership within an organization by its UUID. Use this to view information about a user's assignment to a particular role, including when they were assigned and their organization member details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this role membership |
| `role_id` | string | Yes | Role UUID to retrieve membership from |
| `organization_id` | string | Yes | Organization UUID containing the role |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get session group summaries

**Slug:** `POSTHOG_GET_SESSION_GROUP_SUMMARIES`

Tool to retrieve stored group session summaries for a project. Use when you need to list or access session grouping summaries. Supports pagination via limit and offset parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch session recording playlist details

**Slug:** `POSTHOG_GET_SESSION_RECORDING_PLAYLIST_DETAILS`

Retrieve session recording playlist details for a specific project by project_id and playlist short_id. Requires PersonalAPIKeyAuth with read access. Returns playlist metadata including creation and modification info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `short_id` | string | Yes | Short Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get survey response statistics

**Slug:** `POSTHOG_GET_SURVEY_RESPONSE_STATISTICS`

Get survey response statistics for a specific survey. Returns event counts, unique respondents, and conversion rates. Use when analyzing survey performance and engagement metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `date_to` | string | No | Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z). Filters statistics to events occurring on or before this date. |
| `date_from` | string | No | Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z). Filters statistics to events occurring on or after this date. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `exclude_archived` | boolean | No | Optional boolean to exclude archived responses. If false or not provided, includes archived responses. If true, excludes archived responses from statistics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get surveys archived response UUIDs

**Slug:** `POSTHOG_GET_SURVEYS_ARCHIVED_RESPONSE_UUIDS`

Tool to get list of archived response UUIDs for HogQL filtering. Returns list of UUIDs that the frontend can use to filter out archived responses in HogQL queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get surveys stats

**Slug:** `POSTHOG_GET_SURVEYS_STATS`

Tool to get aggregated response statistics across all surveys for a project. Use when you need to analyze overall survey performance, response rates, and dismissal rates. Optionally filter statistics by date range using ISO timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_to` | string | No | ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z). Filters statistics to events on or before this date. |
| `date_from` | string | No | ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z). Filters statistics to events on or after this date. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve unused organization pipeline frontend apps

**Slug:** `POSTHOG_GET_UNUSED_ORG_PIPELINE_FRONTEND_APPS`

Retrieve a list of pipeline frontend apps that are available but not currently in use within a specific organization. This is useful for discovering apps that could be enabled or removed. Returns details including app IDs, types, names, descriptions, and URLs. **IMPORTANT AUTHENTICATION NOTE**: This endpoint requires session-based authentication (cookie-based auth from browser sessions) and does NOT support Personal API Key authentication. When using Personal API Keys, this endpoint will return a 403 Forbidden error. To use this endpoint, authentication must be done through a browser session with proper organization access. Args: organization_id: The UUID of the organization to query Returns: A list of unused pipeline frontend apps with their metadata

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The UUID of the organization to retrieve unused pipeline frontend apps for. You can get organization IDs from actions like POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user home settings

**Slug:** `POSTHOG_GET_USER_HOME_SETTINGS`

Tool to retrieve user home settings including homepage and tab configurations. Use when you need to fetch the personalized home page and tab settings for a user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uuid` | string | Yes | UUID of the user to retrieve home settings for. Use '@me' to get settings for the authenticated user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user interviews

**Slug:** `POSTHOG_GET_USER_INTERVIEWS`

Tool to retrieve paginated list of user interviews for a specific project. Use when you need to access interview recordings, transcripts, and summaries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get warehouse saved queries activity

**Slug:** `POSTHOG_GET_WAREHOUSE_SAVED_QUERIES_ACTIVITY`

Tool to retrieve activity details for a specific warehouse saved query in PostHog. Use when you need to check the execution history, status, and metadata of a data warehouse saved query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this data warehouse saved query. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get warehouse saved query

**Slug:** `POSTHOG_GET_WAREHOUSE_SAVED_QUERY`

Tool to retrieve a warehouse saved query from PostHog data warehouse. Use when you need to get details about a specific saved query including its status, execution history, and configuration. Returns complete information about the saved query including creator details, query definition, and execution status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this data warehouse saved query. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get warehouse table

**Slug:** `POSTHOG_GET_WAREHOUSE_TABLE`

Retrieve details of a specific data warehouse table by its UUID. Use this to inspect warehouse table configuration, credentials, schema, and format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this data warehouse table. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Warehouse Tables

**Slug:** `POSTHOG_GET_WAREHOUSE_TABLES`

Tool to retrieve a paginated list of warehouse tables for a specific project. Use when you need to list, search, or discover warehouse tables. Supports pagination via limit/offset and filtering via search term.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | A search term to filter warehouse tables by name. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get web experiment

**Slug:** `POSTHOG_GET_WEB_EXPERIMENT`

Tool to retrieve a specific web experiment by ID from a PostHog project. Use when you need to fetch configuration details about a web experiment including variants and feature flag mapping.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this web experiment. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get web vitals

**Slug:** `POSTHOG_GET_WEB_VITALS`

Tool to retrieve web vitals metrics for a specific pathname in a PostHog project. Returns Core Web Vitals data including INP (Interaction to Next Paint), LCP (Largest Contentful Paint), CLS (Cumulative Layout Shift), and FCP (First Contentful Paint) as 90th percentile values over the past 7 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pathname` | string | Yes | Filter web vitals by pathname. Specify the page path to get web vitals data for (e.g., /home, /about). |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initiate domain verification with saml config

**Slug:** `POSTHOG_INITIATE_DOMAIN_VERIFICATION_WITH_SAML_CONFIG`

Initiates domain verification for SAML SSO authentication. This endpoint triggers the verification process for a previously created domain by checking if the required DNS TXT record has been added. **Requirements:** - Enterprise plan with SAML SSO feature - Domain must be created first via CREATE_DOMAIN_WITH_SAML_FOR_ORGANIZATION - DNS TXT record with verification_challenge value must be published **Verification Process:** 1. Create domain and receive verification_challenge value 2. Add TXT record to your domain's DNS: _posthog-challenge.yourdomain.com with the challenge value 3. Call this endpoint to verify - PostHog checks for the DNS record 4. If found, domain is_verified becomes true and SAML SSO is activated **Common Errors:** - 403: Organization lacks Enterprise plan or proper permissions - 404: Domain ID not found in organization - Verification may fail if DNS record not propagated yet (can take up to 48 hours) POST /api/organizations/{organization_id}/domains/{id}/verify/

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the domain to verify (obtained from CREATE_DOMAIN_WITH_SAML_FOR_ORGANIZATION response) |
| `domain` | string | No | (Optional) Domain name to update (e.g., 'company.com'). Leave empty to keep existing value. |
| `has_saml` | boolean | No | (Optional) Indicates whether SAML configuration is present for this domain |
| `is_verified` | boolean | No | (Optional) Manually set verification status. Normally set automatically by the verification process. |
| `verified_at` | string | No | (Optional) ISO 8601 timestamp of when domain was verified. Normally set automatically. |
| `saml_acs_url` | string | No | (Optional) SAML Assertion Consumer Service URL where IdP sends authentication responses |
| `saml_entity_id` | string | No | (Optional) SAML Identity Provider Entity ID URL (e.g., 'https://idp.company.com/entityid') |
| `saml_x509_cert` | string | No | (Optional) X.509 certificate from SAML Identity Provider in PEM format for signature verification |
| `organization_id` | string | Yes | UUID of the organization that owns this domain |
| `sso_enforcement` | string | No | (Optional) SSO enforcement policy: 'strict' requires all domain users to use SSO, empty/null makes SSO optional |
| `verification_challenge` | string | No | (Optional) New DNS TXT record challenge value. Leave empty to keep existing challenge. |
| `jit_provisioning_enabled` | boolean | No | (Optional) Enable/disable Just-In-Time user provisioning: automatically creates PostHog users on first SSO login |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List alerts for project

**Slug:** `POSTHOG_LIST_ALERTS`

Tool to retrieve all alerts configured for a specific PostHog project. Use when you need to view alert configurations, check alert status, or monitor what alerts are set up. Returns paginated list of alerts with their configurations, thresholds, and current states.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all projects across organizations

**Slug:** `POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS`

Tool to list all projects the authenticated user can access by enumerating organizations and aggregating each organization's projects. Use when you need to discover all available projects without knowing organization IDs upfront. Handles pagination internally and returns a unified list with organization context.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List and filter project events

**Slug:** `POSTHOG_LIST_AND_FILTER_PROJECT_EVENTS`

This endpoint for listing/filtering events is deprecated and maintained only for compatibility. Users are discouraged from using it and should use the Query endpoint for ad-hoc lists/aggregations or CDP/Batch Exports for bulk exports.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Only return events with a timestamp after this time. |
| `event` | string | No | Filter list by event. For example `user sign up` or `$pageview`. |
| `limit` | integer | No | The maximum number of results to return |
| `where` | string | No | (Experimental) JSON-serialized array of HogQL expressions that must pass |
| `before` | string | No | Only return events with a timestamp before this time. |
| `format` | string ("csv" | "json") | No | Format |
| `offset` | integer | No | The initial index from which to return the results. |
| `select` | string | No | (Experimental) JSON-serialized array of HogQL expressions to return |
| `person_id` | integer | No | Filter list by person id. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | string | No | Filter events by event property, person property, cohort, groups and more. Pass as JSON array string, e.g. '[{"key":"email","value":"test@example.com","operator":"exact","type":"person"}]' |
| `distinct_id` | integer | No | Filter list by distinct id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List and manage project annotations

**Slug:** `POSTHOG_LIST_AND_MANAGE_PROJECT_ANNOTATIONS`

Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | A search term. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List and manage project feature flags

**Slug:** `POSTHOG_LIST_AND_MANAGE_PROJECT_FEATURE_FLAGS`

List all feature flags for a specific project with pagination support. Returns detailed information about each flag including its key, name, filters, rollout configuration, associated experiments/surveys, user access levels, and metadata. Use the project_id from LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS or similar actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID (numeric) of the project to list feature flags for. Obtain this from LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS or similar project listing actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Batch Export Runs

**Slug:** `POSTHOG_LIST_BATCH_EXPORT_RUNS`

List runs for a batch export by `batch_export_id` within a project. Supports pagination & ordering of the results. Requires `batch_export:read` permission. Returns status, errors, counts, and timestamps for each run.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | The pagination cursor value. |
| `ordering` | string | No | Which field to use when ordering the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `batch_export_id` | string | Yes | Batch Export Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List conversations tickets

**Slug:** `POSTHOG_LIST_CONVERSATIONS_TICKETS`

Tool to list tickets with person data attached for a project. Use when you need to retrieve all tickets in a project, with optional pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List dashboard sharing configs

**Slug:** `POSTHOG_LIST_DASHBOARD_SHARING_CONFIGS`

Retrieve a list of dashboard sharing configurations for a specified project and dashboard. Requires dashboard ID, project ID, and sharing read permission via PersonalAPIKeyAuth. Returns JSON array of sharing settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `dashboard_id` | integer | Yes | Dashboard Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List endpoints for project

**Slug:** `POSTHOG_LIST_ENDPOINTS`

Tool to list all endpoints for the team. Use when you need to retrieve or discover available endpoints within a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List endpoint versions

**Slug:** `POSTHOG_LIST_ENDPOINT_VERSIONS`

Tool to list all versions for a specific endpoint in PostHog. Use when you need to retrieve version history or check available versions for an endpoint. Requires both the project ID and the endpoint name to fetch the versions list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | URL-safe name for the endpoint |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List error tracking autocapture controls

**Slug:** `POSTHOG_LIST_ERROR_TRACKING_AUTOCAPTURE_CONTROLS`

Tool to list error tracking autocapture controls for a PostHog project. Returns paginated list of autocapture configurations including library settings, URL triggers, and sampling rates. Use when you need to view or audit error tracking autocapture settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List experiment saved metrics

**Slug:** `POSTHOG_LIST_EXPERIMENT_SAVED_METRICS`

Tool to list experiment saved metrics for a project with pagination support. Use when you need to retrieve saved metric configurations for experiments in a PostHog project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List feature flag role access details

**Slug:** `POSTHOG_LIST_FEATURE_FLAG_ROLE_ACCESS_DETAILS`

This GET endpoint returns role access details for a feature flag in a project, needs 'project_id' & 'feature_flag_id', and offers optional 'limit' & 'offset' for pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `feature_flag_id` | integer | Yes | Feature Flag Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List file system resources

**Slug:** `POSTHOG_LIST_FILE_SYSTEM`

Tool to list file system resources for a PostHog project with pagination support. Use when you need to browse or search through available file system resources in a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | A search term to filter file system resources. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List specific type groups with pagination

**Slug:** `POSTHOG_LIST_GROUPS_BY_TYPE`

List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | The pagination cursor value. |
| `search` | string | Yes | Search the group name |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `group_type_index` | integer | Yes | Specify the group type to list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List live debugger breakpoint hits

**Slug:** `POSTHOG_LIST_LIVE_DEBUGGER_BREAKPOINT_HITS`

Tool to retrieve breakpoint hit events from ClickHouse with optional filtering and pagination. Use when you need to view hit events containing stack traces, local variables, and execution context from your application's runtime. Breakpoint IDs are filtered to only include those belonging to the current team for security.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of hits to return (default: 100, max: 1000) |
| `offset` | integer | No | Pagination offset for retrieving additional results (default: 0) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `breakpoint_ids` | string | No | Filter hits for specific breakpoints. For multiple IDs, repeat the parameter (e.g., ?breakpoint_ids=uuid1&breakpoint_ids=uuid2) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List active live debugger breakpoints

**Slug:** `POSTHOG_LIST_LIVE_DEBUGGER_BREAKPOINTS_ACTIVE`

Tool to fetch active live debugger breakpoints for external client applications using Project API key. Returns a list of breakpoints that client applications can use to instrument their code accordingly. Supports filtering by enabled status, filename, or repository.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Only return enabled breakpoints. When true, filters the results to show only active breakpoints. |
| `filename` | string | No | Filter breakpoints for a specific file. Provide the filename to narrow down results to a particular source file. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS. |
| `repository` | string | No | Filter breakpoints for a specific repository. Format: 'Owner/RepoName' (e.g., 'PostHog/posthog'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List notebooks with filters and pagination

**Slug:** `POSTHOG_LIST_NOTEBOOKS`

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | No | If any value is provided for this parameter, return notebooks created by the logged in user.  |
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `date_to` | string | No | Filter for notebooks created before this date & time |
| `contains` | string | No | Filter for notebooks that match a provided filter.                 Each match pair is separated by a colon,                 multiple match pairs can be sent separated by a space or a comma  |
| `date_from` | string | No | Filter for notebooks created after this date & time |
| `created_by` | integer | No | The UUID of the Notebook"s creator |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List or delete persons with optional filters

**Slug:** `POSTHOG_LIST_OR_DELETE_PERSONS_WITH_OPTIONAL_FILTERS`

This endpoint is for reading/deleting persons. For creating/updating, use the capture API, set/unset properties, or SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Filter persons by email (exact match) |
| `limit` | integer | No | Number of results to return per page. |
| `format` | string ("csv" | "json") | No | Format |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | Search persons, either by email (full text search) or distinct_id (exact match).  |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | string | No | Filter Persons by person properties. Pass as JSON array string, e.g. '[{"key":"email","value":"test@example.com","operator":"exact"}]' |
| `distinct_id` | string | No | Filter list by distinct id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization s batch exports with pagination

**Slug:** `POSTHOG_LIST_ORGANIZATION_BATCH_EXPORTS`

Retrieve paginated batch exports for an organization, with filters and optional limits. Includes team, interval, and status details. Access requires PersonalAPIKeyAuth with batch_export:read rights.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization domains with pagination

**Slug:** `POSTHOG_LIST_ORGANIZATION_DOMAINS`

Fetch a list of an organization's domains with pagination using `limit` and `offset`. Access requires `organization_id` and a PersonalAPIKeyAuth. Optional parameters available. Provides domain info, verification, and SAML setup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of domains to return per page. If not specified, uses API default. Typical values: 10-100. |
| `offset` | integer | No | Number of domains to skip before starting to return results. Use for pagination (e.g., offset=10 with limit=10 gets page 2). |
| `organization_id` | string | Yes | UUID of the organization whose domains to list. Format: ULID (e.g., '019c0f23-23a7-0000-7ac5-aa71625ba783'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization integrations

**Slug:** `POSTHOG_LIST_ORGANIZATION_INTEGRATIONS`

Tool to list organization-level integrations with read-only access. Use when you need to view integrations scoped to an entire organization (e.g., Vercel, AWS Marketplace). Creation is handled by integration installation flows; deletion requires contacting support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page |
| `offset` | integer | No | The initial index from which to return the results |
| `organization_id` | string | Yes | UUID of the organization whose integrations you want to list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization invites with pagination

**Slug:** `POSTHOG_LIST_ORGANIZATION_INVITES`

Retrieve a paginated list of all pending and active invites for an organization. This action lists all organization invites including: - Email address of invitees - Access level (1=member, 8=admin, 15=owner) - Invite status (expired/active) - Creator information - Optional custom messages Use pagination parameters (limit/offset) for large invite lists. The response includes total count and next/previous URLs for easy page navigation. Requires organization_member:read permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of invites to return per page. If not specified, API defaults to 100. Use smaller values (e.g., 10-50) for efficient pagination. |
| `offset` | integer | No | Number of invites to skip before returning results. Use with 'limit' for pagination (e.g., offset=20 with limit=10 returns invites 21-30). |
| `organization_id` | string | Yes | UUID of the PostHog organization to retrieve invites from. Get this from the user profile or organization list endpoints. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization members with pagination

**Slug:** `POSTHOG_LIST_ORGANIZATION_MEMBERS`

List all members of a specific organization with pagination support. Returns detailed member information including user profiles, membership levels, authentication status, and join dates. Use this to discover who has access to an organization, audit membership, or integrate with user management workflows. Supports pagination via limit and offset parameters for handling organizations with many members. Requires organization_member:read permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of members to return per page (default: 100). Use smaller values for faster responses. |
| `offset` | integer | No | Number of members to skip before starting to return results (default: 0). Use with limit for pagination. |
| `organization_id` | string | Yes | UUID of the organization whose members you want to list. You can get this from the current user profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization s pipeline destinations

**Slug:** `POSTHOG_LIST_ORGANIZATION_PIPELINE_DESTINATIONS`

Retrieve a paginated list of an organization's pipeline destinations by ID, with optional count and offset parameters. Requires PersonalAPIKeyAuth (plugin:read). Returns details like ID, type, and organization info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization's Pipeline Frontend Apps

**Slug:** `POSTHOG_LIST_ORGANIZATION_PIPELINE_FRONTEND_APPS`

Retrieve a paginated list of available pipeline frontend apps for a specific organization. Frontend apps are site apps that inject code into websites (e.g., notification bars, bug reporters, pineapple mode). Returns detailed information including app configuration schemas, versions, and metadata. Supports pagination via limit and offset parameters. Required: organization_id (UUID format) Optional: limit (number of results per page), offset (starting index)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of frontend apps to return per page (optional). Use for pagination. |
| `offset` | integer | No | Starting index for pagination (optional). Use with limit to fetch specific pages. |
| `organization_id` | string | Yes | Organization UUID (required). The organization whose frontend apps you want to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization s pipeline import apps

**Slug:** `POSTHOG_LIST_ORGANIZATION_PIPELINE_IMPORT_APPS`

Retrieve a paginated list of pipeline import applications for a specified organization by ID. Supports optional 'limit' and 'offset' query parameters for result pagination. Requires an organization UUID and a Personal API Key for authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization s pipeline transformations

**Slug:** `POSTHOG_LIST_ORGANIZATION_PIPELINE_TRANSFORMATIONS`

Retrieve paginated pipeline transformation lists for an organization using `limit` and `offset`, requiring a UUID and PersonalAPIKeyAuth. Supports filtering and detailed views.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization Plugins with Pagination

**Slug:** `POSTHOG_LIST_ORGANIZATION_PLUGINS`

Retrieve the list of plugins for a specified organization. Supports pagination through 'limit' and 'offset' query parameters. Requires a valid organization UUID and PersonalAPIKeyAuth for access. Returns plugin details including types and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization whose plugins you want to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List projects in organization with pagination

**Slug:** `POSTHOG_LIST_ORGANIZATION_PROJECTS`

Projects for the current organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `organization_id` | string | Yes | Organization ID (UUID format, e.g., '019690d1-9c3f-0000-8dcf-9601a9a5ac90'). Use POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LIST to get valid organization IDs. Cannot be empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization proxy records

**Slug:** `POSTHOG_LIST_ORGANIZATION_PROXY_RECORDS`

Retrieve a paginated list of custom domain proxy records for an organization. Proxy records enable routing PostHog analytics through your own domain to bypass ad blockers. Each record includes the domain, CNAME target, status ('waiting', 'issuing', 'live'), and metadata. Use 'limit' and 'offset' parameters for pagination. Requires organization read access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of proxy records to return per page (default varies by API). Use with 'offset' for pagination. |
| `offset` | integer | No | The starting index for results (0-based). For example, offset=10 skips the first 10 records. Use with 'limit' for pagination. |
| `organization_id` | string | Yes | The UUID of the organization to retrieve proxy records from. Example: '019c0f24-2413-0000-bbbc-d276c57e0dbb' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization roles with pagination

**Slug:** `POSTHOG_LIST_ORGANIZATION_ROLES`

List all roles in an organization with pagination support. Returns role details including ID, name, creation timestamp, creator information, assigned members, and default status. Use limit and offset parameters for pagination through large role lists. Requires authentication with PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. If not specified, all roles are returned. |
| `offset` | integer | No | The initial index from which to return the results. Use with limit for pagination. |
| `organization_id` | string | Yes | The UUID of the organization whose roles you want to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List pipeline destination configs with pagination

**Slug:** `POSTHOG_LIST_PIPELINE_DESTINATION_CONFIGS`

List pipeline destination configurations for a given project by ID, with optional pagination through 'limit' and 'offset' query parameters. Returns details such as plugin info and delivery rates. Authentication required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. If not specified, returns all results. |
| `offset` | integer | No | The initial index from which to return the results. Use with limit for pagination. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List pipeline frontend app configs

**Slug:** `POSTHOG_LIST_PIPELINE_FRONTEND_APP_CONFIGS`

List all pipeline frontend app configurations for a project. Pipeline frontend apps are plugins that add UI extensions to PostHog (e.g., custom visualizations, dashboards, etc.). Returns a paginated list of configurations including enabled status, order, plugin details, and filters. Use 'limit' and 'offset' parameters for pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. If not specified, returns all results. |
| `offset` | integer | No | The initial index from which to return the results. Use with limit for pagination. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List product tours

**Slug:** `POSTHOG_LIST_PRODUCT_TOURS`

Tool to retrieve a paginated list of product tours for a specific project. Use when you need to view all product tours configured in a project. Supports pagination with limit and offset, and search filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `search` | string | No | A search term. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project actions with pagination and filters

**Slug:** `POSTHOG_LIST_PROJECT_ACTIONS`

Get paginated project actions with filters by format. Query params: limit, offset. Needs PersonalAPIKeyAuth for read. Includes ID, name, description, metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `format` | string ("csv" | "json") | No | Format |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project batch exports with pagination

**Slug:** `POSTHOG_LIST_PROJECT_BATCH_EXPORTS`

Retrieve an indexed list of batch exports for a specified project with optional pagination. View export details, statuses, and pagination links. Requires project ID and supports PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project configuration plugin logs

**Slug:** `POSTHOG_LIST_PROJECT_CONFIGURATION_PLUGIN_LOGS`

Retrieve logs for a specific plugin configuration within a project. Supports pagination with limit and offset query parameters. Requires project and plugin configuration IDs. Auth: PersonalAPIKeyAuth with plugin:read scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `plugin_config_id` | string | Yes | Plugin Config Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project dashboard collaborators

**Slug:** `POSTHOG_LIST_PROJECT_DASHBOARD_COLLABORATORS`

Retrieve the list of collaborators for a specific dashboard within a project. This endpoint returns all users who have been explicitly added as collaborators to the dashboard, along with their access levels and timestamps. Dashboard owners and project admins are not included in this list as they have inherent access. **Parameters:** - project_id: The project identifier (string). Get from POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS. - dashboard_id: The dashboard identifier (integer). Get from POSTHOG_LIST_PROJECT_DASHBOARDS_WITH_PAGINATION. **Returns:** A list of collaborators with the following details for each: - user_uuid: Unique identifier of the collaborator - level: Access level (37 = can edit, 21 = can view) - added_at: Timestamp when the collaborator was added - updated_at: Timestamp of last update **Authentication:** Requires PersonalAPIKeyAuth with `dashboard:read` permission. **Note:** Returns an empty list if the dashboard has no explicit collaborators.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS or POSTHOG_RETRIEVE_CURRENT_USER_PROFILE. |
| `dashboard_id` | integer | Yes | The unique integer identifier of the dashboard. Use POSTHOG_LIST_PROJECT_DASHBOARDS_WITH_PAGINATION to find available dashboard IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project dashboards with pagination

**Slug:** `POSTHOG_LIST_PROJECT_DASHBOARDS`

Get paginated dashboards for a project by ID, using 'limit' and 'offset'. Must authenticate with PersonalAPIKeyAuth. Includes count, pagination, and dashboard details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project dashboard templates

**Slug:** `POSTHOG_LIST_PROJECT_DASHBOARD_TEMPLATES`

Retrieve available dashboard templates for a PostHog project. Dashboard templates are pre-configured dashboards that help users quickly set up analytics for common use cases like user research, pirate metrics (AARRR), web analytics, error tracking, and more. Each template includes ready-to-use insights and visualizations. Returns a paginated list of templates with their configuration, including tiles, filters, and preview images. Use the 'limit' and 'offset' parameters to paginate through results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of dashboard templates to return per page (for pagination). If not specified, returns all available templates. |
| `offset` | integer | No | Number of templates to skip before starting to return results (for pagination). Use with 'limit' to paginate through results. |
| `project_id` | string | Yes | The numeric ID of the PostHog project. You can find this by calling list_all_projects_across_organizations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project early access features

**Slug:** `POSTHOG_LIST_PROJECT_EARLY_ACCESS_FEATURES`

Retrieve a paginated list of a project's early access features by ID with 'limit' and 'offset' parameters. An API key is needed. Includes feature info like creation date, stage, and documentation link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project experiments with pagination

**Slug:** `POSTHOG_LIST_PROJECT_EXPERIMENTS`

Get a paginated list of experiments within a project using 'limit' and 'offset' parameters. Need a valid project ID and 'experiment:read' permission. Returns details like features and metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project export items with pagination

**Slug:** `POSTHOG_LIST_PROJECT_EXPORT_ITEMS`

Retrieve a paginated list of export items for a specific project by ID with optional 'limit' and 'offset' query parameters. Requires PersonalAPIKeyAuth for export:read permission. Supports multiple export formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project group types by id

**Slug:** `POSTHOG_LIST_PROJECT_GROUP_TYPES`

List all group types configured for a PostHog project. Group types are used to organize entities (like companies, organizations, or teams) in PostHog analytics. Each project can have up to 5 group types (indexed 0-4). Returns an array of group type objects, each containing: - group_type: Unique identifier for the group type - group_type_index: Numeric index (0-4) - name_singular: Optional display name (singular form) - name_plural: Optional display name (plural form) Use this action before querying specific groups to discover available group types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | The numeric ID of the PostHog project (e.g., '302160'). To find available project IDs, use the list_all_projects action. Note: This must be the numeric project ID, not the UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project membership details

**Slug:** `POSTHOG_LIST_PROJECT_MEMBERSHIP_DETAILS`

Retrieve a list of project membership details for a specified project by ID. Members and their roles, such as member or admin, are included along with their join and update timestamps. Note: This endpoint only works for projects with access control enabled (private projects). If the project does not have access control enabled, the API will return a 404 "Endpoint not found" error. Access control is an Enterprise feature that can be enabled in Project Settings > Access Control. To check if a project has access control enabled, use the POSTHOG_RETRIEVE_CURRENT_USER_PROFILE action and look for the "access_control" field in the team/project data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/ or use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE. Note: This endpoint only works for projects with access_control enabled (private projects). Projects without access_control will return a 404 error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project pipeline configurations

**Slug:** `POSTHOG_LIST_PROJECT_PIPELINE_CONFIGURATIONS`

List all pipeline transformation configurations for a specific project. Pipeline transformations enable you to modify, enrich, or filter events in realtime before they are ingested into PostHog. This endpoint returns a paginated list of all transformation configurations for the specified project. Use the `limit` and `offset` parameters to paginate through results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of pipeline transformation configurations to return per page. If not specified, the API will use its default page size. |
| `offset` | integer | No | The initial index from which to return results (used for pagination). For example, offset=10 will skip the first 10 results. |
| `project_id` | string | Yes | Project ID of the project whose pipeline transformation configurations you want to list. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Listprojectpipelineimportconfigs

**Slug:** `POSTHOG_LIST_PROJECT_PIPELINE_IMPORT_CONFIGS`

List pipeline import app configurations for a specified project, with pagination options 'limit' and 'offset'. Requires a project ID and supports PersonalAPIKeyAuth for security. Responds with JSON objects including configuration details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project plugin configurations

**Slug:** `POSTHOG_LIST_PROJECT_PLUGIN_CONFIGURATIONS`

List all plugin configurations for a specific project. Plugin configurations define which plugins (apps) are installed and enabled for a project, along with their settings and execution order. This endpoint returns a paginated list of all plugin configurations for the specified project. Use the `limit` and `offset` parameters to paginate through results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of plugin configurations to return per page. If not specified, the API will use its default page size. |
| `offset` | integer | No | The initial index from which to return results (used for pagination). For example, offset=10 will skip the first 10 results. |
| `project_id` | string | Yes | Project ID of the project whose plugin configurations you want to list. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project session recordings

**Slug:** `POSTHOG_LIST_PROJECT_SESSION_RECORDINGS`

Retrieve a paginated list of session recordings for a specific project, including viewing times and user interactions. Specify `project_id`, and use optional `limit` and `offset` query parameters to control result set size and starting point.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project subscriptions with pagination

**Slug:** `POSTHOG_LIST_PROJECT_SUBSCRIPTIONS`

Retrieve a paginated list of subscriptions for a given project by its ID. Optional query params include 'limit' for results per page and 'offset' for results starting index. Authentication is required. Returns subscription details and navigation links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List paginated surveys for a project

**Slug:** `POSTHOG_LIST_PROJECT_SURVEYS`

Get paginated surveys for a project with its ID, using 'limit' and 'offset'. Needs PersonalAPIKeyAuth ('survey:read'). JSON output includes survey info, links, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Role Memberships Paginated

**Slug:** `POSTHOG_LIST_ROLE_MEMBERSHIPS`

List all users assigned to a specific role within an organization. Role memberships represent the assignment of users to custom roles in PostHog. This endpoint returns a paginated list of users who have been assigned the specified role, allowing you to audit role assignments and manage access control. Use this action to: - View which users are assigned to a particular role - Audit role-based access control in your organization - Track role membership changes over time Pagination is controlled via 'limit' (page size) and 'offset' (starting position) query parameters. The 'organization_id' and 'role_id' are required path parameters that identify the specific role within a specific organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `role_id` | string | Yes | The unique identifier (UUID) of the role for which to list memberships. Use the organization roles list endpoint to get valid role IDs. |
| `organization_id` | string | Yes | The unique identifier (UUID) of the organization containing the role. Use the organization list or details endpoints to get valid organization IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of project s session recording playlists

**Slug:** `POSTHOG_LIST_SESSION_RECORDING_PLAYLISTS`

List all session recording playlists for a PostHog project, including both user-created playlists and system-generated synthetic playlists (like "Watch history", "Recordings with comments", etc.). Session recording playlists organize recordings into collections or filter-based groups for easier analysis. Two playlist types exist: - 'filters': Dynamic playlists that automatically include recordings matching specified criteria - 'collection': Manual collections where recordings are explicitly added The response includes synthetic playlists (negative IDs) that are automatically maintained by PostHog, along with custom playlists created by users. Use pagination with limit/offset for large result sets. Requires 'session_recording_playlist:read' permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of playlists to return per page. Useful for pagination. If not specified, API will use its default page size. |
| `offset` | integer | No | Number of playlists to skip before returning results. Use with 'limit' for pagination (e.g., offset=10, limit=10 for page 2). |
| `short_id` | string | No | Filter by the short alphanumeric ID of a specific playlist (e.g., 'ReFeVQ8X'). Note: In testing, this parameter may not filter results as expected. |
| `created_by` | integer | No | Filter playlists by the ID of the user who created them. Use this to find playlists created by a specific team member. |
| `project_id` | string | Yes | Project ID (numeric) of the PostHog project. This is the numeric 'id' field from project objects, not the UUID. Required path parameter. Example: '302160' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List session recording sharing configs

**Slug:** `POSTHOG_LIST_SESSION_RECORDING_SHARING_CONFIGS`

Retrieve a list of sharing configurations for a specific session recording in a project, including creation timestamps and access tokens. Requires project and recording IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `recording_id` | string | Yes | Recording Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List unused organization pipeline transformations

**Slug:** `POSTHOG_LIST_UNUSED_ORGANIZATION_PIPELINE_TRANSFORMATIONS`

Retrieve a list of unused pipeline transformations for a specified organization, identified by UUID. Includes details like name, plugin type, and configuration. Supports JSON response format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List users with staff filter and pagination

**Slug:** `POSTHOG_LIST_USERS_WITH_STAFF_FILTER_AND_PAGINATION`

API endpoint fetches a user list with staff filter, pagination (limit, offset), and requires a personal API key. Data includes UUIDs, emails, and organizational details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `is_staff` | boolean | No | Filter users by staff status. Set to true to return only staff users, false to return only non-staff users, or omit to return all users. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List warehouse saved queries

**Slug:** `POSTHOG_LIST_WAREHOUSE_SAVED_QUERIES`

Tool to retrieve warehouse saved queries for a project. Use when you need to list or search saved queries from the data warehouse. Supports pagination via page parameter and filtering via search term.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | A page number within the paginated result set. |
| `search` | string | No | A search term to filter warehouse saved queries. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List web experiments

**Slug:** `POSTHOG_LIST_WEB_EXPERIMENTS`

Tool to retrieve a paginated list of web experiments for a specific project. Use when you need to discover available web experiments. Supports pagination via 'limit' and 'offset' parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Manage feature flag enrichment for usage dashboard

**Slug:** `POSTHOG_MANAGE_FEATURE_FLAG_ENRICHMENT_FOR_USAGE_DASHBOARD`

Learn to manage feature flags (creation, access, modification, removal) using PostHog's docs, with options to use a JavaScript Library or a dedicated endpoint for user-specific flag status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `key` | string | No | Key |
| `name` | string | No | contains the description for the flag (field name `name` is kept for backwards-compatibility)  |
| `tags` | array | No | Tags |
| `active` | boolean | No | Active |
| `deleted` | boolean | No | Deleted |
| `filters` | object | No | Filters |
| `surveys` | object | No | Surveys |
| `can_edit` | boolean | No | Can Edit |
| `features` | object | No | Features |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `experiment_set` | array | No | Experiment Set |
| `is_simple_flag` | boolean | No | Is Simple Flag |
| `usage_dashboard` | integer | No | Usage Dashboard |
| `performed_rollback` | boolean | No | Performed Rollback |
| `rollout_percentage` | integer | No | Rollout Percentage |
| `rollback_conditions` | string | No | Rollback Conditions |
| `analytics_dashboards` | array | No | Analytics Dashboards |
| `has_enriched_analytics` | boolean | No | Has Enriched Analytics |
| `ensure_experience_continuity` | boolean | No | Ensure Experience Continuity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Crud operations for project annotations

**Slug:** `POSTHOG_MANAGE_PROJECT_ANNOTATIONS`

Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Id |
| `scope` | string ("dashboard_item" | "dashboard" | "project" | "organization") | No | * `dashboard_item` - insight * `dashboard` - dashboard * `project` - project * `organization` - organization  |
| `content` | string | No | Content |
| `deleted` | boolean | No | Deleted |
| `created_at` | string | Yes | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | Yes | Updated At |
| `date_marker` | string | No | Date Marker |
| `dashboard_id` | integer | Yes | Dashboard Id |
| `insight_name` | string | Yes | Insight Name |
| `creation_type` | string ("USR" | "GIT") | No | * `USR` - user * `GIT` - GitHub |
| `dashboard_item` | integer | No | Dashboard Item |
| `dashboard_name` | string | Yes | Dashboard Name |
| `insight_short_id` | string | Yes | Insight Short Id |
| `insight_derived_name` | string | Yes | Insight Derived Name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Manage project feature flags for local evaluation

**Slug:** `POSTHOG_MANAGE_PROJECT_FEATURE_FLAGS_FOR_LOCAL_EVALUATION`

Retrieve all feature flag definitions for a project to enable local evaluation. This endpoint returns flag configurations, cohort definitions, and group type mappings that allow SDKs and applications to evaluate feature flags locally without making additional API calls for each flag check. This improves performance and reduces latency when checking feature flags for users. Use this when implementing server-side local evaluation in your application or when you need to cache flag definitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark dashboard template as deleted

**Slug:** `POSTHOG_MARK_DASHBOARD_TEMPLATE_AS_DELETED`

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this dashboard template. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark insight as viewed with configurable format

**Slug:** `POSTHOG_MARK_INSIGHT_AS_VIEWED_WITH_CONFIGURABLE_FORMAT`

Marks one or more insights as viewed by the current user for a specified project. This endpoint records user engagement with insights and is idempotent. Requires `project_id` and `insight_ids` (a list of insight IDs to mark as viewed). Supports optional `format` parameter ('csv' or 'json') to control response serialization. Use this to track which insights a user has viewed, helping to surface new or unviewed insights in the UI or analytics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Response format: 'json' or 'csv'. Controls the serialization format of the response data. Defaults to JSON if not specified. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `insight_ids` | array | Yes | List of unique integer values identifying the insights to mark as viewed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project timing insights

**Slug:** `POSTHOG_MARK_INSIGHTS_AS_VIEWED`

Record insights as viewed by updating their last_viewed_at timestamps. This endpoint tracks when a user views insights, which is useful for: - Activity tracking and analytics - Recently viewed insights features - User engagement metrics **IMPORTANT**: This endpoint requires session-based (cookie) authentication and does NOT support Personal API Key authentication. Attempting to use this endpoint with a Personal API Key (Bearer token) will result in a 403 Forbidden error. Use this action only when authenticated with session cookies from a logged-in PostHog user session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Response format (csv or json) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `insight_ids` | array | Yes | List of insight IDs to record as viewed (updates the last_viewed_at timestamp for each insight) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Prevent hard delete notebook by flagging

**Slug:** `POSTHOG_MARK_NOTEBOOK_AS_DELETED`

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `short_id` | string | Yes | Short Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move dashboard tile

**Slug:** `POSTHOG_MOVE_DASHBOARD_TILE`

Endpoint to move a tile from one dashboard to another. Requires `project_id` (in path), `id` (source dashboard ID in path), `tile` (object with `id` of the tile to move), and `toDashboard` (destination dashboard ID). Returns the updated source dashboard info after the tile has been moved.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying the source dashboard (dashboard to move the tile FROM). |
| `tile` | object | Yes | The tile object containing the tile ID to move. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `toDashboard` | integer | Yes | The ID of the destination dashboard to move the tile TO. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update alert configuration

**Slug:** `POSTHOG_PATCH_ALERT`

Tool to update an existing alert configuration in PostHog. Use when you need to modify alert settings such as name, enabled status, thresholds, or subscribed users. Performs a partial update (PATCH) - only fields provided in the request will be updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this alert configuration. |
| `name` | string | No | Alert name. Maximum 255 characters. |
| `config` | object | No | Alert configuration settings |
| `enabled` | boolean | No | Whether the alert is enabled |
| `insight` | integer | No | Insight ID monitored by this alert |
| `condition` | object | No | Alert condition configuration |
| `threshold` | object | No | Alert threshold object |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `skip_weekend` | boolean | No | Whether to skip checks during weekends |
| `snoozed_until` | string | No | ISO 8601 timestamp until which the alert is snoozed |
| `subscribed_users` | array | No | User IDs to subscribe to this alert |
| `calculation_interval` | string | No | Calculation interval for the alert (can be string or object) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Batch Export

**Slug:** `POSTHOG_PATCH_BATCH_EXPORT`

Update an existing batch export configuration in PostHog by partially modifying fields like name, paused status, destination, or schedule. Use when you need to modify batch export settings without replacing the entire configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to update |
| `name` | string | No | A human-readable name for this batch export |
| `model` | string | No | Which model this batch export is exporting (e.g., events, persons, sessions) |
| `end_at` | string | No | ISO 8601 timestamp - time after which any batch export runs won't be triggered |
| `paused` | boolean | No | Whether this batch export is paused or not. Set to true to pause, false to resume |
| `schema` | object | No | A schema of custom fields to select when exporting data |
| `filters` | object | No | Filter configuration to specify which data to export |
| `interval` | string ("hour" | "day" | "week" | "every 5 minutes") | No | Enum for batch export interval options |
| `start_at` | string | No | ISO 8601 timestamp - time before which any batch export runs won't be triggered |
| `offset_day` | integer | No | Day offset for the batch export schedule (0-6, where 0 is Sunday) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |
| `destination` | object | No | Destination configuration for batch export |
| `hogql_query` | string | No | HogQL query string for filtering or transforming exported data |
| `offset_hour` | integer | No | Hour offset for the batch export schedule (0-23) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark product onboarding complete

**Slug:** `POSTHOG_PATCH_COMPLETE_PRODUCT_ONBOARDING`

Tool to mark a specific product onboarding as complete for a PostHog project. Use when a user has finished onboarding for features like product_analytics, session_replay, feature_flags, surveys, error_tracking, or data_warehouse. Updates the project's onboarding completion status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this project |
| `product_type` | string ("product_analytics" | "session_replay" | "feature_flags" | "surveys" | "error_tracking" | "data_warehouse") | Yes | The product type to mark as onboarding complete. Valid values include: product_analytics, session_replay, feature_flags, surveys, error_tracking, data_warehouse |
| `organization_id` | string | Yes | Organization UUID that owns the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Customer Profile Config

**Slug:** `POSTHOG_PATCH_CUSTOMER_PROFILE_CONFIG`

Update a customer profile configuration by partially modifying fields like content, scope, or sidebar. Use when you need to modify specific fields of an existing customer profile config without replacing the entire object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this customer profile config. |
| `scope` | string ("person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4") | No | Scope of the customer profile configuration |
| `content` | object | No | Content configuration for the customer profile. Can be any JSON object with arbitrary fields. |
| `sidebar` | object | No | Sidebar configuration for the customer profile. Can be any JSON object with arbitrary fields. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Dataset

**Slug:** `POSTHOG_PATCH_DATASET`

Tool to partially update a dataset in a PostHog project. Use when you need to modify dataset properties like name or description. Only the fields provided in the request will be updated; other fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this dataset. |
| `name` | string | No | Dataset name (max 400 characters) |
| `deleted` | boolean | No | Soft-delete indicator for the dataset |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Dataset description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Dataset Item

**Slug:** `POSTHOG_PATCH_DATASET_ITEM`

Tool to partially update a dataset item by its ID in a PostHog project. Use when you need to modify specific fields of a dataset item such as input, output, metadata, or reference fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this dataset item. |
| `input` | object | No | Input data for the dataset item |
| `output` | object | No | Output data for the dataset item |
| `deleted` | boolean | No | Whether the dataset item should be marked as deleted |
| `metadata` | object | No | Metadata associated with the dataset item |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `ref_trace_id` | string | No | Reference trace ID (max 255 characters) |
| `ref_source_id` | string | No | Reference source ID (max 255 characters) |
| `ref_timestamp` | string | No | Reference timestamp (ISO 8601 datetime format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch endpoint

**Slug:** `POSTHOG_PATCH_ENDPOINT`

Tool to partially update an endpoint for a project. Use when you need to modify specific fields of an existing endpoint without replacing the entire configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | URL-safe name for the endpoint |
| `query` | object | No | Query configuration for the endpoint |
| `is_active` | boolean | No | Whether the endpoint is active |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description for the endpoint |
| `is_materialized` | boolean | No | Whether the endpoint query is materialized |
| `cache_age_seconds` | integer | No | Cache age in seconds for the endpoint |
| `derived_from_insight` | string | No | Insight ID from which this endpoint is derived |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch error tracking autocapture controls

**Slug:** `POSTHOG_PATCH_ERROR_TRACKING_AUTOCAPTURE_CONTROLS`

Partially update an error tracking autocapture control configuration. Use this to modify settings like sample rate, URL triggers, event triggers, and match type for a specific autocapture control.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking auto capture controls. |
| `library` | string | No | Library identifier for error tracking configuration |
| `match_type` | string ("all" | "any") | No | Match type for triggers: 'all' means all conditions must match, 'any' means at least one condition must match |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `sample_rate` | string | No | Sample rate for error tracking (decimal string format between -1.00 and 1.00, e.g., '0.95' for 95%) |
| `url_triggers` | array | No | List of URL patterns that trigger error tracking |
| `url_blocklist` | array | No | List of URL patterns to exclude from error tracking |
| `event_triggers` | array | No | List of event triggers that activate error tracking autocapture |
| `linked_feature_flag` | string | No | Feature flag linked to this autocapture control (can be a string ID or a feature flag object) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Evaluation

**Slug:** `POSTHOG_PATCH_EVALUATION`

Update an evaluation by patching specific fields. Use when you need to modify evaluation settings like description, enabled status, or configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this evaluation |
| `name` | string | No | Name of the evaluation (max 400 characters) |
| `deleted` | boolean | No | Whether the evaluation is deleted |
| `enabled` | boolean | No | Whether the evaluation is enabled |
| `conditions` | string | No | Conditions for the evaluation |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |
| `description` | string | No | Description of the evaluation |
| `output_type` | string ("boolean") | No | Output type enum |
| `output_config` | object | No | Output configuration |
| `evaluation_type` | string ("llm_judge") | No | Evaluation type enum |
| `evaluation_config` | object | No | Configuration for the evaluation |
| `model_configuration` | object | No | Model configuration for evaluation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partial experiment update in project

**Slug:** `POSTHOG_PATCH_EXPERIMENT`

Endpoint enables partial updates to an experiment in a project using PATCH, needing `project_id`, `experiment_id`, and various payload types. Returns updated details. Authentication is mandatory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `filters` | string | No | Filters |
| `archived` | boolean | No | Archived |
| `end_date` | string | No | End Date |
| `created_at` | string | No | Created At |
| `parameters` | string | No | Parameters |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | No | Start Date |
| `updated_at` | string | No | Updated At |
| `description` | string | No | Description |
| `exposure_cohort` | integer | No | Exposure Cohort |
| `feature_flag_key` | string | No | Feature Flag Key |
| `secondary_metrics` | string | No | Secondary Metrics |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch experiment saved metric

**Slug:** `POSTHOG_PATCH_EXPERIMENT_SAVED_METRIC`

Tool to partially update an experiment saved metric by ID in a PostHog project. Use when you need to modify specific fields of a saved metric configuration for experiments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment saved metric. |
| `name` | string | No | Name of the experiment saved metric (max 400 characters) |
| `tags` | array | No | List of tags associated with the saved metric |
| `query` | object | No | Query configuration for the saved metric |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the experiment saved metric (max 400 characters) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch External Data Source

**Slug:** `POSTHOG_PATCH_EXTERNAL_DATA_SOURCE`

Tool to update an external data source in PostHog by patching specific fields like description or configuration. Use when you need to modify an existing data source without replacing all fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this external data source. |
| `prefix` | string | No | Prefix to apply to data imported from this source |
| `account_id` | string | No | Account identifier for the external data source |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the external data source (maximum 400 characters) |
| `client_secret` | string | No | Client secret for authenticating with the external data source |
| `revenue_analytics_config` | object | No | Revenue analytics configuration for the external data source. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch file system

**Slug:** `POSTHOG_PATCH_FILE_SYSTEM`

Tool to partially update a file system resource by UUID and project ID. Use when you need to update specific fields like last_viewed_at, metadata, or other file system attributes without replacing the entire resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this file system. |
| `ref` | string | No | Reference identifier for the file system (max 100 characters) |
| `href` | string | No | URL reference to the file system resource |
| `meta` | object | No | Additional metadata associated with the file system |
| `path` | string | No | Path of the file system resource |
| `type` | string | No | Type of the file system resource (max 100 characters) |
| `depth` | integer | No | Depth level of the file system resource |
| `shortcut` | boolean | No | Whether this file system is a shortcut |
| `created_at` | string | No | ISO 8601 timestamp of when the file system was created |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `last_viewed_at` | string | No | ISO 8601 timestamp of when the file system was last viewed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch file system shortcut

**Slug:** `POSTHOG_PATCH_FILE_SYSTEM_SHORTCUT`

Tool to partially update a file system shortcut in PostHog by its UUID. Use when you need to modify specific fields of an existing shortcut without replacing all data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this file system shortcut. |
| `ref` | string | No | Reference identifier for the shortcut, maximum length 100 characters. |
| `href` | string | No | The URL/link associated with this file system shortcut. |
| `path` | string | No | The path for the file system shortcut. |
| `type` | string | No | The type of the file system shortcut (e.g., 'query', 'dashboard'). |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update group usage metric

**Slug:** `POSTHOG_PATCH_GROUPS_TYPES_METRICS`

Tool to update a group usage metric configuration in PostHog. Use when you need to modify metric settings such as display format, filters, or interval. Performs a partial update (PATCH) - only fields provided in the request will be updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this group usage metric. |
| `name` | string | No | Name of the group usage metric |
| `format` | string ("numeric" | "currency") | No | Format for the group usage metric |
| `display` | string ("number" | "sparkline") | No | Display format for the group usage metric |
| `filters` | object | No | Filters to apply to the group usage metric |
| `interval` | integer | No | Interval in days for the metric |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `group_type_index` | integer | Yes | Index of the group type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch hog function

**Slug:** `POSTHOG_PATCH_HOG_FUNCTION`

Tool to partially update a hog function by UUID and project ID. Use when you need to modify specific fields of a hog function such as description, enabled status, filters, or configuration without replacing the entire resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this hog function. |
| `hog` | string | No | Hog code for the function |
| `name` | string | No | Name of the hog function (max 400 characters) |
| `type` | string | No | Type of the hog function |
| `inputs` | object | No | Input values for the hog function with bytecode, order, templating, transpiled, and value properties |
| `deleted` | boolean | No | Whether the hog function is marked as deleted (soft delete) |
| `enabled` | boolean | No | Whether the hog function is enabled |
| `filters` | object | No | Filter configuration for the hog function including actions, events, properties, and source |
| `masking` | object | No | Masking configuration with hash, ttl, bytecode, and threshold properties |
| `icon_url` | string | No | URL of the icon for the hog function |
| `mappings` | array | No | Mappings configuration for the hog function with filters, inputs, inputs_schema, and name properties |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the hog function |
| `template_id` | string | No | Template ID (max 400 characters) |
| `inputs_schema` | array | No | Schema defining the inputs for the hog function with key and type as required fields |
| `batch_export_id` | string | No | UUID of the associated batch export |
| `execution_order` | integer | No | Execution order of the hog function (0-32767) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Insight Variable

**Slug:** `POSTHOG_PATCH_INSIGHT_VARIABLE`

Update an insight variable by partially modifying its properties (name, type, default value, etc.). Use when you need to modify specific fields of an existing insight variable without replacing the entire object.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this insight variable. |
| `name` | string | No | Name of the insight variable (max 400 characters) |
| `type` | string ("String" | "Number" | "Boolean" | "List" | "Date") | No | Type of insight variable |
| `values` | string | No | Possible values for the insight variable (for List type variables) |
| `code_name` | string | No | Code name for the insight variable, used for programmatic access |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `default_value` | string | No | Default value for the insight variable. Type depends on the 'type' field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch live debugger breakpoint

**Slug:** `POSTHOG_PATCH_LIVE_DEBUGGER_BREAKPOINT`

Tool to update a live debugger breakpoint by UUID and project ID. Use when you need to modify breakpoint properties like line number, enabled state, or condition without recreating it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this live debugger breakpoint. |
| `enabled` | boolean | No | Whether the breakpoint is enabled. Set to false to disable the breakpoint without deleting it. |
| `filename` | string | No | Filename where the breakpoint is set. |
| `condition` | string | No | Condition expression for the breakpoint. If specified, the breakpoint will only trigger when this condition evaluates to true. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `repository` | string | No | Repository identifier for the breakpoint. |
| `line_number` | integer | No | Line number where the breakpoint is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization domain properties

**Slug:** `POSTHOG_PATCH_ORGANIZATION_DOMAIN`

Updates selected properties of a domain in an organization via PATCH request, supports various data formats but SAML fields are immutable. Authentication needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this domain. |
| `domain` | string | No | Domain |
| `saml_acs_url` | string | No | Saml Acs Url |
| `saml_entity_id` | string | No | Saml Entity Id |
| `saml_x509_cert` | string | No | Saml X509 Cert |
| `organization_id` | string | Yes | Organization Id |
| `sso_enforcement` | string | No | Sso Enforcement |
| `jit_provisioning_enabled` | boolean | No | Jit Provisioning Enabled |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update partial role details in organization

**Slug:** `POSTHOG_PATCH_ORGANIZATION_ROLE`

PATCH /api/organizations/{organization_id}/roles/{id}/: Update partial details of a role by ID within an organization, including name and feature flag access level. Requires UUIDs for both organization and role. Supports JSON, form, and multipart data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `members` | string | No | Members |
| `created_at` | string | No | Created At |
| `organization_id` | string | Yes | Organization Id |
| `associated_flags` | string | No | Associated Flags |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch persisted folder

**Slug:** `POSTHOG_PATCH_PERSISTED_FOLDER`

Tool to partially update a persisted folder by ID for a PostHog project. Use when you need to modify specific attributes of an existing persisted folder configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this Persisted Folder. |
| `path` | string | No | Path of the persisted folder |
| `type` | string ("home" | "pinned" | "custom_products") | No | Type of the persisted folder: home, pinned, or custom_products |
| `protocol` | string | No | Protocol used for the persisted folder (maximum 64 characters) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Person partial update via project id

**Slug:** `POSTHOG_PATCH_PERSON`

This endpoint allows reading and deleting individuals. For creation or updates, use the capture API, `$set`/`$unset` properties, or SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `uuid` | string | No | Uuid |
| `format` | string ("csv" | "json") | No | Format |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | string | No | Properties |
| `distinct_ids` | array | No | Distinct Ids |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch product tour

**Slug:** `POSTHOG_PATCH_PRODUCT_TOUR`

Tool to partially update a product tour in PostHog. Use when you need to modify specific fields of an existing tour like description, archived status, dates, or content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this product tour. |
| `name` | string | No | Name of the product tour (maximum 400 characters). |
| `content` | string | No | Content of the product tour. |
| `archived` | boolean | No | Whether the product tour is archived. |
| `end_date` | string | No | End date for the tour in ISO 8601 format. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `start_date` | string | No | Start date for the tour in ISO 8601 format. |
| `auto_launch` | boolean | No | Whether the tour should launch automatically. |
| `description` | string | No | Description of the product tour. |
| `linked_flag_id` | integer | No | ID of the linked feature flag. |
| `creation_context` | string ("app" | "toolbar") | No | Enum for creation context values. |
| `targeting_flag_filters` | string | No | Targeting flag filters for the tour. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project action with partial data

**Slug:** `POSTHOG_PATCH_PROJECT_ACTION`

Update an action within a project with a specified ID. Supports partial updates. Accepts JSON, form-data, and query parameters including 'project_id' and 'id'. Formats response in CSV or JSON. Requires 'action:write' permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `tags` | array | No | Tags for organizing and categorizing actions. |
| `steps` | array | No | Action steps defining the criteria (event, properties, selectors). |
| `format` | string ("csv" | "json") | No | Format |
| `deleted` | boolean | No | Deleted |
| `team_id` | integer | No | Team Id |
| `is_action` | boolean | No | Is Action |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `post_to_slack` | boolean | No | Post To Slack |
| `bytecode_error` | string | No | Bytecode Error |
| `is_calculating` | boolean | No | Is Calculating |
| `last_calculated_at` | string | No | Last Calculated At |
| `slack_message_format` | string | No | Slack Message Format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partial update project annotation

**Slug:** `POSTHOG_PATCH_PROJECT_ANNOTATION`

Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `scope` | string ("dashboard_item" | "dashboard" | "project" | "organization") | No | * `dashboard_item` - insight * `dashboard` - dashboard * `project` - project * `organization` - organization  |
| `content` | string | No | Content |
| `deleted` | boolean | No | Deleted |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | Updated At |
| `date_marker` | string | No | Date Marker |
| `dashboard_id` | integer | No | Dashboard Id |
| `insight_name` | string | No | Insight Name |
| `creation_type` | string ("USR" | "GIT") | No | * `USR` - user * `GIT` - GitHub |
| `dashboard_item` | integer | No | Dashboard Item |
| `dashboard_name` | string | No | Dashboard Name |
| `insight_short_id` | string | No | Insight Short Id |
| `insight_derived_name` | string | No | Insight Derived Name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update partial project cohort details

**Slug:** `POSTHOG_PATCH_PROJECT_COHORT`

Update partial cohort details for a specific project. Requires a cohort ID and project ID, supports JSON, form data, and accepts patch changes like name or description. Returns updated cohort data. Auth required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `count` | integer | No | Count |
| `query` | string | No | Query |
| `groups` | string | No | Groups |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `is_static` | boolean | No | Is Static |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `experiment_set` | array | No | Experiment Set |
| `is_calculating` | boolean | No | Is Calculating |
| `last_calculation` | string | No | Last Calculation |
| `errors_calculating` | integer | No | Errors Calculating |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partial update of a project s dashboard

**Slug:** `POSTHOG_PATCH_PROJECT_DASHBOARD`

Endpoint PATCH /api/projects/{project_id}/dashboards/{id}: Allows partial update of a project's dashboard with specified ID. Accepts JSON, form data, and provides a detailed response schema based on user license. Requires dashboard write access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this dashboard. |
| `name` | string | No | The display name of the dashboard (e.g., 'Sales Dashboard', 'User Analytics'). |
| `tags` | array | No | List of tags for categorizing and organizing the dashboard (e.g., ['analytics', 'sales', 'q1-2024']). |
| `tiles` | array | No | Dashboard tiles/widgets configuration. Each tile represents an insight, text card, or other widget with layout and display settings. |
| `pinned` | boolean | No | Whether the dashboard should be pinned to the top for quick access. Set to true to pin, false to unpin. |
| `deleted` | boolean | No | Soft delete flag. Set to true to mark the dashboard as deleted without permanently removing it. |
| `filters` | string | No | Dashboard-level filters to apply to all tiles (e.g., date ranges, property filters). Accepts a dictionary with filter configurations. |
| `is_shared` | boolean | No | Whether the dashboard is shared publicly or with specific users. Set to true to enable sharing. |
| `created_at` | string | No | The creation timestamp of the dashboard in ISO 8601 format (e.g., '2024-01-15T10:30:00Z'). Typically read-only. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | A detailed description of what this dashboard contains or its purpose. |
| `use_template` | string | No | Template ID to apply to this dashboard (e.g., 'default', 'product-analytics'). Useful for creating dashboards from predefined templates. |
| `use_dashboard` | integer | No | Dashboard ID to copy/duplicate from. Use this to create a new dashboard based on an existing one's structure. |
| `delete_insights` | boolean | No | Whether to delete all insights when deleting the dashboard. Set to true to remove insights, false to keep them. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partial update of a project s feature flag

**Slug:** `POSTHOG_PATCH_PROJECT_FEATURE_FLAG`

Learn to manage feature flags (create, read, update, delete) using PostHog's docs, with options for JavaScript Library use or dedicated endpoints for user flag status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. Used only as a path parameter. |
| `key` | string | No | Key |
| `name` | string | No | contains the description for the flag (field name `name` is kept for backwards-compatibility)  |
| `tags` | array | No | Tags |
| `active` | boolean | No | Active |
| `deleted` | boolean | No | Deleted |
| `filters` | object | No | Filters |
| `surveys` | object | No | Surveys |
| `can_edit` | boolean | No | Can Edit |
| `features` | object | No | Features |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/. Used only as a path parameter. |
| `experiment_set` | array | No | Experiment Set |
| `is_simple_flag` | boolean | No | Is Simple Flag |
| `usage_dashboard` | integer | No | Usage Dashboard |
| `performed_rollback` | boolean | No | Performed Rollback |
| `rollout_percentage` | integer | No | Rollout Percentage |
| `rollback_conditions` | string | No | Rollback Conditions |
| `analytics_dashboards` | array | No | Analytics Dashboards |
| `has_enriched_analytics` | boolean | No | Has Enriched Analytics |
| `ensure_experience_continuity` | boolean | No | Ensure Experience Continuity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partial update of a project insight

**Slug:** `POSTHOG_PATCH_PROJECT_INSIGHT`

The PATCH endpoint supports partial insight updates in a project, allows format specification (CSV/JSON), and requires `PersonalAPIKeyAuth` and `insight:write` scope for access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `tags` | array | No | Tags |
| `hogql` | string | No | Hogql |
| `order` | integer | No | Order |
| `query` | string | No | Query node JSON string |
| `saved` | boolean | No | Saved |
| `types` | string | No | Types |
| `format` | string ("csv" | "json") | No | Format |
| `result` | string | No | Result |
| `columns` | string | No | Columns |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `short_id` | string | No | Short Id |
| `timezone` | string | No | The timezone this chart is displayed in. |
| `favorited` | boolean | No | Favorited |
| `is_cached` | string | No | Is Cached |
| `is_sample` | boolean | No | Is Sample |
| `created_at` | string | No | Created At |
| `dashboards` | array | No |          DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.         A dashboard ID for each of the dashboards that this insight is displayed on.           |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | Updated At |
| `description` | string | No | Description |
| `derived_name` | string | No | Derived Name |
| `last_refresh` | string | No |      The datetime this insight"s results were generated.     If added to one or more dashboards the insight can be refreshed separately on each.     Returns the appropriate last_refresh datetime for the context the insight is viewed in     (see from_dashboard query parameter).       |
| `query_status` | string | No | Query Status |
| `dashboard_tiles` | array | No |      A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.       |
| `cache_target_age` | string | No | The target age of the cached results for this insight. |
| `last_modified_at` | string | No | Last Modified At |
| `next_allowed_client_refresh` | string | No |      The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed     by querying the database.       |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project member role by uuid

**Slug:** `POSTHOG_PATCH_PROJECT_MEMBER`

Update a project member's role using their UUID in a specific project. Accepts partial data to modify membership details such as role level, provided the member's UUID and project ID. Note: This endpoint only works for projects with access control enabled (private projects). Access control is an Enterprise feature that can be enabled in Project Settings > Access Control. If the project does not have access control enabled, the API will return a 404 "Endpoint not found" error. To use this endpoint: 1. Ensure the project has access_control: true (Enterprise feature) 2. Use list explicit_members endpoint to get existing member UUIDs 3. Provide the parent_membership_user_uuid (the user's UUID from membership)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Id |
| `level` | integer | No | The access level for the user. Common values: 1 (member), 8 (admin). |
| `joined_at` | string | No | Joined At |
| `user_uuid` | string | No | User Uuid |
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint only works for projects with access control enabled (private projects). |
| `updated_at` | string | No | Updated At |
| `parent_level` | integer | No | Parent Level |
| `parent_membership_id` | string | No | Parent Membership Id |
| `parent__membership__user__uuid` | string | Yes | Parent Membership User Uuid |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partial update of project notebook

**Slug:** `POSTHOG_PATCH_PROJECT_NOTEBOOK`

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Id |
| `title` | string | No | Title |
| `content` | string | No | Content |
| `deleted` | boolean | No | Deleted |
| `version` | integer | No | Version |
| `short_id` | string | Yes | Short Id |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `text_content` | string | No | Text Content |
| `last_modified_at` | string | No | Last Modified At |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Partially update project property definition

**Slug:** `POSTHOG_PATCH_PROJECT_PROPERTY_DEFINITION`

PATCH /api/projects/{project_id}/property_definitions/{id}/: Partially update a specific property definition by UUID in a project. Requires property_definition:write auth. No response body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this property definition. |
| `tags` | array | No | List of tags associated with the property definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `property_type` | string | No | The type of property. Possible values include: 'Boolean', 'Numeric', 'String', 'DateTime'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update partial subscription details

**Slug:** `POSTHOG_PATCH_PROJECT_SUBSCRIPTION`

PATCH /api/projects/{project_id}/subscriptions/{id}/: Update partial details of a specific project subscription by ID. Modify target, frequency, and more. Requires subscription:write permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `count` | integer | No | Count |
| `title` | string | No | Title |
| `deleted` | boolean | No | Deleted |
| `insight` | integer | No | Insight |
| `summary` | string | No | Summary |
| `bysetpos` | integer | No | Bysetpos |
| `interval` | integer | No | Interval |
| `byweekday` | array | No | Byweekday |
| `dashboard` | integer | No | Dashboard |
| `frequency` | string ("daily" | "weekly" | "monthly" | "yearly" | "hourly") | No | * `daily` - Daily * `weekly` - Weekly * `monthly` - Monthly * `yearly` - Yearly  |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | No | Start Date |
| `until_date` | string | No | Until Date |
| `target_type` | string ("email" | "slack" | "webhook") | No | * `email` - Email * `slack` - Slack * `webhook` - Webhook |
| `target_value` | string | No | Target Value |
| `invite_message` | string | No | Invite Message |
| `next_delivery_date` | string | No | Next Delivery Date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update partial survey details

**Slug:** `POSTHOG_PATCH_PROJECT_SURVEY`

Update partial survey details by PATCH to /api/projects/{project_id}/surveys/{id}/ with UUID. Edit attributes like name, type, questions, targeting, and flags. Needs PersonalAPIKeyAuth for write access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `type` | string ("popover" | "widget" | "button" | "email" | "full_screen" | "api") | No | * `popover` - popover * `widget` - widget * `button` - button * `email` - email * `full_screen` - full screen * `api` - api  |
| `archived` | boolean | No | Archived |
| `end_date` | string | No | End Date |
| `questions` | string | No |          The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.         Basic (open-ended question)         - `type`: `open`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `branching`: Branching logic for the question. See branching types below for details.         Link (a question with a link)         - `type`: `link`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `link`: The URL associated with the question.         - `branching`: Branching logic for the question. See branching types below for details.         Rating (a question with a rating scale)         - `type`: `rating`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `display`: Display style of the rating (`number` or `emoji`).         - `scale`: The scale of the rating (`number`).         - `lowerBoundLabel`: Label for the lower bound of the scale.         - `upperBoundLabel`: Label for the upper bound of the scale.         - `branching`: Branching logic for the question. See branching types below for details.         Multiple choice         - `type`: `single_choice` or `multiple_choice`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `choices`: An array of choices for the question.         - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).         - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).         - `branching`: Branching logic for the question. See branching types below for details.         Branching logic can be one of the following types:         Next question: Proceeds to the next question         ```json         {             "type": "next_question"         }         ```         End: Ends the survey, optionally displaying a confirmation message.         ```json         {             "type": "end"         }         ```         Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.         ```json         {             "type": "response_based",             "responseValues": {                 "responseKey": "value"             }         }         ```         Specific question: Proceeds to a specific question by index.         ```json         {             "type": "specific_question",             "index": 2         }         ```           |
| `appearance` | string | No | Appearance |
| `conditions` | string | No | Conditions |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | No | Start Date |
| `description` | string | No | Description |
| `linked_flag_id` | integer | No | Linked Flag Id |
| `iteration_count` | integer | No | Iteration Count |
| `responses_limit` | integer | No | Responses Limit |
| `current_iteration` | integer | No | Current Iteration |
| `targeting_flag_id` | integer | No | Targeting Flag Id |
| `iteration_start_dates` | array | No | Iteration Start Dates |
| `remove_targeting_flag` | boolean | No | Remove Targeting Flag |
| `targeting_flag_filters` | string | No | Targeting Flag Filters |
| `iteration_frequency_days` | integer | No | Iteration Frequency Days |
| `current_iteration_start_date` | string | No | Current Iteration Start Date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update session recording playlist partially

**Slug:** `POSTHOG_PATCH_SESSION_RECORDING_PLAYLIST`

Update session recording playlists using PATCH on the endpoint with `project_id` and `short_id`. Accepts JSON and forms data for detail amendments. Partial updates allowed. `PersonalAPIKeyAuth` needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Id |
| `name` | string | No | Name |
| `pinned` | boolean | No | Pinned |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `short_id` | string | Yes | Short Id |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `derived_name` | string | No | Derived Name |
| `last_modified_at` | string | No | Last Modified At |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update user profile

**Slug:** `POSTHOG_PATCH_USER`

Tool to update user profile settings in PostHog. Use when you need to modify user information such as name, email, role, theme preferences, or notification settings. Performs a partial update (PATCH) - only fields provided in the request will be updated. Use uuid '@me' to update the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uuid` | string | Yes | User UUID to update. Use '@me' to update the authenticated user. |
| `email` | string | No | User's email address. Maximum 254 characters. Changing email may require verification. |
| `last_name` | string | No | User's last name. Maximum 150 characters. |
| `first_name` | string | No | User's first name. Maximum 150 characters. |
| `theme_mode` | string | No | UI theme preference (e.g., 'light', 'dark', 'auto'). |
| `anonymize_data` | boolean | No | Whether to anonymize the user's data in analytics. |
| `set_current_team` | string | No | Team UUID to set as the current active team (project) for the user. |
| `allow_impersonation` | boolean | No | Whether to allow staff to impersonate this user for support purposes. |
| `role_at_organization` | string ("engineering" | "data" | "product" | "founder" | "leadership" | "marketing" | "sales" | "other") | No | User's role at their organization |
| `notification_settings` | object | No | User notification preferences. Keys represent notification types, values represent whether they are enabled. |
| `passkeys_enabled_for_2fa` | boolean | No | Whether passkeys are enabled for two-factor authentication. Users can disable this to use only TOTP for 2FA while keeping passkeys for login. |
| `set_current_organization` | string | No | Organization UUID to set as the current active organization for the user. |
| `allow_sidebar_suggestions` | boolean | No | Whether to show sidebar suggestions in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch warehouse saved query

**Slug:** `POSTHOG_PATCH_WAREHOUSE_SAVED_QUERY`

Tool to partially update a warehouse saved query in PostHog. Use when you need to modify properties like name, query definition, or sync frequency. Only the fields provided in the request will be updated; other fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this data warehouse saved query. |
| `name` | string | No | User-defined name of the saved query (max 128 characters) |
| `query` | string | No | HogQL query definition for the saved query |
| `origin` | string | No | Where this SavedQuery is created. Can be 'data_warehouse', 'endpoint', or 'managed_viewset'. |
| `status` | string | No | The status of when this SavedQuery last ran. Can be 'Cancelled', 'Modified', 'Completed', 'Failed', or 'Running'. |
| `columns` | string | No | Column definitions for the saved query results |
| `deleted` | boolean | No | Soft-delete indicator. When true, the saved query is marked as deleted. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `soft_update` | boolean | No | Indicates if soft update is enabled |
| `sync_frequency` | string | No | Frequency at which the query syncs |
| `is_materialized` | boolean | No | Indicates if the query results are materialized |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch warehouse tables

**Slug:** `POSTHOG_PATCH_WAREHOUSE_TABLES`

Tool to partially update a warehouse table by patching specific fields like name, format, or schema. Use when you need to modify an existing warehouse table without replacing all fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this data warehouse table. |
| `name` | string | No | Name of the warehouse table (maximum 128 characters) |
| `format` | string ("CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper") | No | Supported data warehouse table formats |
| `columns` | string | No | Column definitions for the warehouse table |
| `deleted` | boolean | No | Whether the warehouse table is marked as deleted |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `url_pattern` | string | No | URL pattern for accessing the warehouse table data (maximum 500 characters) |
| `external_schema` | string | No | External schema definition for the warehouse table |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch web experiment

**Slug:** `POSTHOG_PATCH_WEB_EXPERIMENT`

Tool to partially update a web experiment in PostHog. Use when you need to modify specific fields of an existing web experiment without replacing the entire configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this web experiment. |
| `name` | string | No | Name of the web experiment (max 400 characters) |
| `variants` | object | No | Variants configuration for the web experiment. Keys are variant names (e.g., 'control', 'variant'), values are variant configurations with transforms and rollout percentages |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `feature_flag_key` | string | No | Feature flag key to associate with this web experiment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Batch Export

**Slug:** `POSTHOG_PAUSE_BATCH_EXPORT`

Pause a batch export in PostHog to temporarily stop scheduled data exports. Use when you need to halt data exports without deleting the batch export configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to pause |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Organization Batch Export

**Slug:** `POSTHOG_PAUSE_ORGANIZATION_BATCH_EXPORT`

Pause an organization-level batch export in PostHog. Use when you need to temporarily stop scheduled data exports at the organization level without deleting the batch export configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to pause |
| `organization_id` | string | Yes | UUID of the organization that owns the batch export |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Project Funnel Advanced Analytics

**Slug:** `POSTHOG_PROJECT_FUNNEL_ADVANCED_ANALYTICS`

Create comprehensive funnel analysis for a PostHog project with advanced configuration options. Analyze user conversion through multi-step funnels with customizable time windows, ordering rules, visualization types, breakdowns, and exclusions. Requires at least 2 funnel steps defined via 'events' or 'actions'. Returns conversion rates, drop-off points, and completion metrics in JSON or CSV format. Supports strict/ordered/unordered step sequences, property-based segmentation, and group-level aggregation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | No | List of events to include in the funnel. Each event must have: 'id' (event name), 'type' ('events'), and 'order' (step number starting from 0). At least 2 steps are required. Example: [{'id': 'pageview', 'type': 'events', 'order': 0}, {'id': 'signup', 'type': 'events', 'order': 1}]. One of 'events' or 'actions' is required. |
| `format` | string ("csv" | "json") | No | Response format: 'json' (default) for structured data or 'csv' for spreadsheet export. |
| `actions` | array | No | List of actions to include in the funnel. Each action must have: 'id' (action ID), 'type' ('actions'), and 'order' (step number starting from 0). At least 2 steps are required. One of 'events' or 'actions' is required. |
| `date_to` | string | No | End date for the funnel analysis. Can be a date '2021-01-01' or relative like '-7d', '-1m', 'mStart', 'yStart'. If not specified, defaults to now. |
| `breakdown` | string | No | Property or cohort to break down results by. Type is specified with breakdown_type: 'event' (default) - event property key; 'person' - person property key; 'cohort' - array of cohort IDs like [9581,5812]. |
| `date_from` | string | No | Start date for the funnel analysis. Can be a date '2021-01-01' or relative like '-7d' (last 7 days), '-1m' (last month), 'mStart' (start of month), 'yStart' (start of year). Defaults to '-7d'. |
| `exclusions` | array | No | Exclude users/groups that completed the specified event between two specific steps. Note that these users/groups will be completely excluded from the entire funnel.  |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | object | No | Additional property filters to apply to the funnel query. Filters events based on property conditions. |
| `breakdown_type` | string ("event" | "person" | "cohort") | No | Type of breakdown property: 'event' for event properties, 'person' for user properties, 'cohort' for cohort segmentation. Used with 'breakdown' parameter. |
| `breakdown_limit` | integer | No | Maximum number of breakdown values to return. Default is 10. |
| `funnel_viz_type` | string ("steps" | "time_to_convert" | "trends") | No | Funnel visualization type: 'steps' (default, shows conversion at each step), 'time_to_convert' (shows time between steps), 'trends' (shows funnel over time). |
| `funnel_order_type` | string ("ordered" | "unordered" | "strict") | No | Order requirement for funnel steps: 'ordered' (default, steps in sequence with others allowed between), 'strict' (steps in exact sequence with nothing between), 'unordered' (steps in any order). |
| `funnel_window_days` | integer | No | (DEPRECATED) Funnel window size in days. Use `funnel_window_interval` and `funnel_window_interval_type`  |
| `filter_test_accounts` | boolean | No | Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.  |
| `funnel_window_interval` | integer | No | Funnel conversion window size (numeric value). Used with funnel_window_interval_type to define the time window for completing the funnel. Default is 14 (14 days). |
| `funnel_window_interval_type` | string ("day" | "hour" | "minute" | "week" | "month") | No | Unit for funnel_window_interval: 'day', 'hour', 'minute', 'week', or 'month'. Default is 'day'. |
| `aggregation_group_type_index` | integer | No | Aggregation level: 0 for user-level (default), >0 for group-level aggregation. Group index corresponds to your configured group types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Post Project Trends With Filters

**Slug:** `POSTHOG_PROJECT_TREND_ANALYTICS`

The `/api/projects/{project_id}/insights/trend/` endpoint provides project trends in CSV/JSON, requires `project_id` and optional parameters, and needs 'PersonalAPIKeyAuth'. It outputs event data and cache status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | No | Events to filter on. One of `events` or `actions` is required. |
| `format` | string ("csv" | "json") | No | Format |
| `actions` | array | No | Actions to filter on. One of `events` or `actions` is required. |
| `compare` | boolean | No | To compare or not |
| `date_to` | string | No | What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.  |
| `formula` | string | No | Combine the result of events or actions into a single number. For example `A + B` or `(A-B)/B`. The letters correspond to the order of the `events` or `actions` lists.  |
| `breakdown` | string | No | A property or cohort to break down on. You can select the type of the property with breakdown_type. - `event` (default): a property key - `person`: a person property key - `cohort`: an array of cohort IDs (ie `[9581,5812]`)  |
| `date_from` | string | No | What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.  |
| `compare_to` | string | No | What to compare to |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `filter_test_accounts` | boolean | No | Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rearrange frontend app pipeline configs

**Slug:** `POSTHOG_REARRANGE_FRONTEND_APP_PIPELINE_CONFIGS`

Rearrange (reorder) the configuration of frontend apps in a project's data pipeline. Pipeline frontend apps are plugins that add UI extensions to PostHog such as custom visualizations, dashboards, and interactive components. This endpoint allows you to change the order in which these frontend apps are loaded or displayed, and update their configuration settings. **Usage**: Provide the project_id and the configuration details you want to update, including the order parameter to control sequencing. The order parameter determines the priority/sequence of frontend app execution. **Permissions**: Requires 'plugin:write' permission for the specified project. **Note**: This endpoint modifies existing frontend app configurations. Use the list_pipeline_frontend_app_configs action first to see current configurations before rearranging them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Unique identifier of the frontend app configuration to rearrange |
| `name` | string | No | Human-readable name of the frontend app |
| `error` | string | No | Error message if the frontend app configuration has encountered any issues |
| `order` | integer | No | Display/execution order of the frontend app (lower numbers appear/execute first) |
| `config` | string | No | JSON string containing the frontend app's configuration settings |
| `plugin` | integer | No | ID of the plugin/frontend app associated with this configuration |
| `deleted` | boolean | No | Soft deletion flag - if true, the configuration is marked as deleted but not removed |
| `enabled` | boolean | No | Whether the frontend app is enabled (true) or disabled (false) |
| `filters` | string | No | Optional filters to apply to the frontend app's data processing or display logic |
| `team_id` | integer | No | Team ID associated with this configuration (usually same as project) |
| `created_at` | string | No | ISO 8601 timestamp when the configuration was created |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | ISO 8601 timestamp when the configuration was last updated |
| `description` | string | No | Brief description of what the frontend app does |
| `plugin_info` | string | No | Additional metadata about the plugin in JSON format |
| `delivery_rate_24h` | string | No | The delivery/success rate of the frontend app over the last 24 hours |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rearrange pipeline transformation configs

**Slug:** `POSTHOG_REARRANGE_PIPELINE_TRANSFORMATION_CONFIGS`

Rearrange the execution order of pipeline transformation configurations for a project. This endpoint allows you to change the order in which transformation plugins are executed in the data pipeline. You can also enable/disable specific transformations or update their configuration settings. **Important**: This endpoint requires session-based authentication and does NOT support Personal API Key access. It can only be used with browser session authentication. **Use case**: When you have multiple transformation plugins configured for a project, this endpoint lets you control their execution order by updating the 'order' field, or toggle them on/off using the 'enabled' field. **Note**: To list existing transformation configs first, use the GET endpoint: `/api/projects/{project_id}/pipeline_transformation_configs/`

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | The ID of the specific transformation config to rearrange. You can get this from the list endpoint. |
| `name` | string | No | Human-readable name for this transformation configuration. Helps identify the transformation in the UI and logs. |
| `error` | string | No | Error message if the transformation has encountered any issues. Typically read-only and managed by the system. |
| `order` | integer | No | The execution order of this transformation in the pipeline. Lower numbers execute first. Use this to control the sequence in which transformations are applied to your events. |
| `config` | string | No | Configuration settings for this transformation as a JSON string. The exact structure depends on the specific transformation plugin being used. |
| `plugin` | integer | No | The plugin ID associated with this transformation. This identifies which transformation plugin is being configured. |
| `deleted` | boolean | No | Soft delete flag. Set to true to mark this transformation as deleted without permanently removing it from the database. |
| `enabled` | boolean | No | Whether this transformation is enabled (true) or disabled (false). Disabled transformations will not process events. |
| `filters` | string | No | Filter conditions that determine which events this transformation processes. Can be a JSON object defining event property filters, event name filters, etc. |
| `team_id` | integer | No | The team ID associated with this project. Usually automatically set based on the project. |
| `created_at` | string | No | ISO 8601 timestamp of when this transformation config was created. Typically read-only and managed by the system. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | ISO 8601 timestamp of when this transformation config was last updated. Automatically updated by the system when changes are made. |
| `description` | string | No | Detailed description of what this transformation does. Use this to document the transformation's purpose and behavior. |
| `plugin_info` | string | No | Additional information about the plugin as a JSON string. Contains metadata like plugin name, description, and capabilities. |
| `delivery_rate_24h` | string | No | The delivery success rate for this transformation over the last 24 hours. Typically read-only and used for monitoring transformation performance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rearrange project import app configurations

**Slug:** `POSTHOG_REARRANGE_PROJECT_IMPORT_APP_CONFIGURATIONS`

Rearrange app import settings in a project using PATCH /api/projects/{project_id}/... by updating plug-in order and status. Requires `project_id` and a JSON with configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Id |
| `name` | string | No | Name |
| `error` | string | No | Error |
| `order` | integer | No | Order |
| `config` | string | No | Config |
| `plugin` | integer | No | Plugin |
| `deleted` | boolean | No | Deleted |
| `enabled` | boolean | No | Enabled |
| `filters` | string | No | Filters |
| `team_id` | integer | No | Team Id |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | Updated At |
| `description` | string | No | Description |
| `plugin_info` | string | No | Plugin Info |
| `delivery_rate_24h` | string | No | Delivery Rate 24H |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rearrange project pipeline destination configs

**Slug:** `POSTHOG_REARRANGE_PROJECT_PIPELINE_DESTINATION_CONFIGS`

Rearrange the execution order of pipeline destination configurations for a project. This endpoint allows you to change the order in which destination plugins receive events in the data pipeline. You can also enable/disable specific destinations or update their configuration settings. **Important**: This endpoint requires session-based authentication and does NOT support Personal API Key access. It can only be used with browser session authentication. **Use case**: When you have multiple destination plugins configured for a project, this endpoint lets you control their execution order by updating the 'order' field, or toggle them on/off using the 'enabled' field. **Note**: To list existing destination configs first, use the GET endpoint: `/api/projects/{project_id}/pipeline_destination_configs/`

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | The ID of the specific destination config to rearrange. You can get this from the list endpoint. |
| `name` | string | No | Human-readable name for this destination configuration. Helps identify the destination in the UI and logs. |
| `error` | string | No | Error message if the destination has encountered any issues. Typically read-only and managed by the system. |
| `order` | integer | No | The execution order of this destination in the pipeline. Lower numbers execute first. Use this to control the sequence in which destinations receive your events. |
| `config` | string | No | Configuration settings for this destination as a JSON string. The exact structure depends on the specific destination plugin being used. |
| `plugin` | integer | No | The plugin ID associated with this destination. This identifies which destination plugin is being configured. |
| `deleted` | boolean | No | Soft delete flag. Set to true to mark this destination as deleted without permanently removing it from the database. |
| `enabled` | boolean | No | Whether this destination is enabled (true) or disabled (false). Disabled destinations will not receive events. |
| `filters` | string | No | Filter conditions that determine which events this destination receives. Can be a JSON object defining event property filters, event name filters, etc. |
| `team_id` | integer | No | The team ID associated with this project. Usually automatically set based on the project. |
| `created_at` | string | No | ISO 8601 timestamp of when this destination config was created. Typically read-only and managed by the system. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `updated_at` | string | No | ISO 8601 timestamp of when this destination config was last updated. Automatically updated by the system when changes are made. |
| `description` | string | No | Detailed description of what this destination does. Use this to document the destination's purpose and behavior. |
| `plugin_info` | string | No | Additional information about the plugin as a JSON string. Contains metadata like plugin name, description, and capabilities. |
| `delivery_rate_24h` | string | No | The delivery success rate for this destination over the last 24 hours. Typically read-only and used for monitoring destination performance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create experiment timeseries recalculation

**Slug:** `POSTHOG_RECALCULATE_EXPERIMENT_TIMESERIES`

Tool to create a recalculation request for experiment timeseries data. Use when you need to recalculate metrics for an experiment. The experiment must have a start_date set (must be started) for recalculation to work.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment. |
| `metric` | object | Yes | The full metric object to recalculate. This should contain the metric configuration including type (e.g., 'primary', 'secondary') and other relevant metric properties. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `fingerprint` | string | Yes | The fingerprint of the metric configuration. This is used to identify the specific metric configuration for recalculation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reconfigure plugin order and status in project

**Slug:** `POSTHOG_RECONFIGURE_PLUGIN_ORDER_AND_STATUS_IN_PROJECT`

Reconfigure the execution order and status of plugin configurations within a project. This endpoint allows you to update plugin configuration settings including: - Execution order (which plugins run first) - Enabled/disabled status - Configuration parameters **IMPORTANT:** This endpoint does NOT support Personal API Key authentication. It requires session-based authentication (browser/UI access only). **Note:** PostHog has transitioned from "plugins" to "pipeline destinations/transformations". This endpoint is part of the legacy plugin system and may have limited functionality. Consider using the pipeline destination/transformation endpoints instead for new integrations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | The ID of the plugin configuration to modify. |
| `name` | string | No | Display name for the plugin configuration. |
| `error` | string | No | Error message if the plugin configuration has issues. |
| `order` | integer | No | The execution order of this plugin configuration. Lower numbers run first. |
| `config` | string | No | JSON string containing the plugin configuration settings. |
| `plugin` | integer | No | The plugin ID associated with this configuration. |
| `deleted` | boolean | No | Whether this plugin configuration has been soft-deleted. |
| `enabled` | boolean | No | Whether the plugin configuration should be enabled or disabled. |
| `filters` | string | No | Filter criteria for when this plugin should process events. |
| `team_id` | integer | No | Team ID associated with this plugin configuration. Usually derived from project_id. |
| `created_at` | string | No | Timestamp when the plugin configuration was created (ISO 8601 format). |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `updated_at` | string | No | Timestamp when the plugin configuration was last updated (ISO 8601 format). |
| `description` | string | No | Human-readable description of what this plugin configuration does. |
| `plugin_info` | string | No | Additional metadata about the plugin. |
| `delivery_rate_24h` | string | No | The delivery rate for this plugin over the last 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Desktop Recording

**Slug:** `POSTHOG_REPLACE_DESKTOP_RECORDING`

Replace a desktop meeting recording in PostHog using PUT. Use when you need to completely replace all recording data including metadata, transcript, participants, and status. Unlike PATCH, this requires all mandatory fields and replaces the entire resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the desktop recording to replace |
| `team` | integer | Yes | Team ID associated with the recording |
| `notes` | string | No | Additional notes about the recording |
| `status` | string ("recording" | "uploading" | "processing" | "ready" | "error") | No | Recording status. |
| `summary` | string | No | AI-generated summary of the recording |
| `platform` | string ("zoom" | "teams" | "meet" | "desktop_audio" | "slack") | Yes | Platform where the recording was made: zoom (Zoom), teams (Microsoft Teams), meet (Google Meet), desktop_audio (Desktop audio), or slack (Slack huddle) |
| `video_url` | string | No | URL of the video recording |
| `created_by` | integer | Yes | User ID of the creator |
| `project_id` | string | Yes | Project ID (environment ID) containing the recording. Find it via /api/projects/ |
| `started_at` | string | No | ISO 8601 timestamp when the recording started |
| `meeting_url` | string | No | URL of the meeting |
| `completed_at` | string | No | ISO 8601 timestamp when the recording was completed |
| `participants` | array | No | List of participant names |
| `error_message` | string | No | Error message if the recording failed |
| `meeting_title` | string | No | Title of the meeting (max 255 characters) |
| `sdk_upload_id` | string | Yes | SDK upload identifier (UUID) |
| `extracted_tasks` | array | No | AI-extracted tasks from the transcript |
| `transcript_text` | string | Yes | Full text of the transcript |
| `duration_seconds` | integer | No | Duration of the recording in seconds |
| `video_size_bytes` | integer | No | Size of the video in bytes |
| `tasks_generated_at` | string | No | ISO 8601 timestamp when the tasks were generated |
| `recall_recording_id` | string | No | Recall recording identifier (UUID) |
| `transcript_segments` | array | No | Transcript segments with timestamps and speaker information |
| `summary_generated_at` | string | No | ISO 8601 timestamp when the summary was generated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset person distinct ID

**Slug:** `POSTHOG_RESET_PERSON_DISTINCT_ID`

Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. Use when you need to recycle a distinct_id from a previously deleted person for reuse.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Response format (csv or json) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `distinct_id` | string | Yes | The distinct_id to reset for a deleted person. This allows the distinct_id to be used again. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve async query status by id

**Slug:** `POSTHOG_RETRIEVE_ASYNC_QUERY_STATUS_BY_ID`

(Experimental)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve last viewed insights for user

**Slug:** `POSTHOG_RETRIEVE_LAST_VIEWED_INSIGHTS_FOR_USER`

Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Response format: 'json' (default) returns structured data, 'csv' returns comma-separated values |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve matching events for session recording

**Slug:** `POSTHOG_RETRIEVE_MATCHING_EVENTS_FOR_SESSION_RECORDING`

Retrieves event IDs matching a filter with one session ID and at least one event/action criterion. Intended for internal use and may have sudden changes. IMPORTANT: This endpoint does NOT support Personal API Key authentication. It requires session-based authentication (browser login) and will return a 403 "permission_denied" error with message "This action does not support Personal API Key access" when called with an API key. This is a limitation of the PostHog API, not the action implementation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint does NOT support Personal API Key access - it requires session-based authentication (browser login). Calling this endpoint with an API key will result in a 403 permission_denied error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve notebook activity for project

**Slug:** `POSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_FOR_PROJECT`

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve notebook activity log

**Slug:** `POSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_LOG`

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `short_id` | string | Yes | Short Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve notebook details

**Slug:** `POSTHOG_RETRIEVE_NOTEBOOK_DETAILS`

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `short_id` | string | Yes | Short Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve or delete person retention data

**Slug:** `POSTHOG_RETRIEVE_OR_DELETE_PERSON_RETENTION_DATA`

This endpoint is for reading and deleting person data; use the capture API, `$set`/`$unset` properties, or SDKs for creation and updates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve or delete project persons funnel data

**Slug:** `POSTHOG_RETRIEVE_OR_DELETE_PROJECT_PERSONS_FUNNEL_DATA`

Retrieves persons who entered or progressed through a funnel in the specified project. Note: This endpoint requires that a funnel has been previously created and analyzed in PostHog. The endpoint returns person-level data for funnel analysis. For creating or analyzing new funnels, use the insights API endpoint at /api/projects/{project_id}/insights/funnel/. This is a read-only endpoint. To create or update persons, use the capture API with $set and $unset properties, or use PostHog SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Response format: 'json' returns structured data, 'csv' returns comma-separated values. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization pipeline frontend app details

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_FRONTEND_APP`

Retrieve pipeline frontend app details for an organization using its 'organization_id' (UUID). Response includes ID, plugin type, name, URL in JSON format, covering various plugin types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Org Pipeline Repo Details

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_REPOSITORY_DETAILS`

Retrieve details for repository pipeline destinations within a specific organization by its UUID. Returns objects like ID, name, and URLs with support for various plugin types (local, custom, etc.).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve org pipeline transformation activity

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_TRANSFORMATION_ACTIVI`

Retrieve org pipeline transformation activity

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization pipeline unsubscribe configs

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_UNSUBSCRIBE_CONFIGS`

Retrieve export unsubscribe configurations for an organization's pipeline frontend apps. Returns a list of unsubscribe configurations defining how users can opt out of frontend app exports (e.g., notification bars, bug reporters). Each config includes an ID, plugin type, and settings. Required: organization_id (UUID). Use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE to get it. **IMPORTANT**: This endpoint requires session-based authentication and does NOT support Personal API Key access. It may return a 403 error stating "This action does not support Personal API Key access" when used with API keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The UUID of the organization to retrieve export unsubscribe configurations for (e.g., '019c0f24-2413-0000-bbbc-d276c57e0dbb'). Use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE or POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to get valid organization IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization plugin activity

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_ACTIVITY`

Retrieve activity details for plugins in a specified organization by ID. Supports various plugin types, including local, custom, and repository. Response includes plugin's id, name, type, and relevant metrics. Requires a valid UUID for 'organization_id'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization plugin details

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_DETAILS`

Retrieve a specific plugin's details for an organization. Requires the plugin's integer ID and the organization's UUID. Only returns plugin info if authenticated with 'plugin:read' permission. Responds with plugin data in JSON format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization plugin repository details

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_REPOSITORY_DETAILS`

Retrieve plugin repository details for a specific organization by its UUID, including plugin type, name, URL, and more. Accessible via GET request to '/api/organizations/{organization_id}/plugins/repository/'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization plugin unsubscribe configs

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_UNSUBSCRIBE_CONFIGS`

Retrieve export unsubscribe configurations for plugins in an organization. Returns a list of unsubscribe configurations for various plugin types (local, custom, repository, source, inline) that define how users can opt out of plugin-based exports. Each config includes details like plugin ID, type, name, description, URL, icon, and settings. Required: organization_id (UUID). Use POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LIST to get it. **IMPORTANT**: This endpoint requires session-based authentication and may NOT support Personal API Key access. It may return a 403 Forbidden error when used with API keys. The endpoint may not be available on all PostHog instances or plans, or may require specific organizational permissions. If you receive a 403 error, the organization may not have access to this feature or the endpoint may be deprecated/removed from the PostHog API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The UUID of the organization to retrieve plugin export unsubscribe configurations for (e.g., '019c0f24-2413-0000-bbbc-d276c57e0dbb'). Use POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LIST or POSTHOG_RETRIEVE_CURRENT_USER_PROFILE to get valid organization IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization project details

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_PROJECT_DETAILS`

Projects for the current organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this team (soon to be environment). |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization role details

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_ROLE_DETAILS`

Retrieve the details of a specific role within an organization using its UUID. Requires the organization's UUID and role's UUID in the path and is protected by PersonalAPIKeyAuth with 'organization:read' scope. Returns role data in JSON.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this role. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve organization s unused pipeline apps

**Slug:** `POSTHOG_RETRIEVE_ORGANIZATION_UNUSED_PIPELINE_APPS`

Retrieve unused pipeline import apps for a specified organization. Endpoint requires an organization_id (UUID) and returns details like plugin type, name, description, and more in JSON format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve paginated organization list

**Slug:** `POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LIST`

Retrieve a paginated list of organizations with optional 'limit' and 'offset' query parameters. The response includes organization details like ID, name, and membership level, with secure access controlled via PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve persisted folder

**Slug:** `POSTHOG_RETRIEVE_PERSISTED_FOLDER`

Tool to retrieve a specific persisted folder by its UUID and project ID. Use when you need to get details about a persisted folder including its type, path, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this Persisted Folder. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve person s activity and delete options

**Slug:** `POSTHOG_RETRIEVE_PERSON_ACTIVITY_AND_DELETE_OPTIONS`

This endpoint is for reading and deleting persons; for creating/updating, use the capture API, `$set`/`$unset` properties, or SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A unique UUID value identifying this person. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve person details by id

**Slug:** `POSTHOG_RETRIEVE_PERSON_DETAILS_BY_ID`

This endpoint is used to read and delete persons. For creating or updating, use the capture API, `$set` and `$unset` properties, or SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A unique UUID value identifying this person. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve persons funnel correlation data

**Slug:** `POSTHOG_RETRIEVE_PERSONS_FUNNEL_CORRELATION_DATA`

**Note**: This endpoint path appears to be incorrectly defined or deprecated in the PostHog API. The documented endpoint `/api/projects/{project_id}/persons/funnel/correlation/` returns 403 Forbidden, suggesting it either: 1. Does not exist as a standalone endpoint (correlation data may be accessed via `/api/projects/{project_id}/persons/funnel/` with query parameters) 2. Is an Enterprise Edition feature requiring a paid plan 3. Has been deprecated in favor of other funnel correlation endpoints For funnel correlation analysis, consider using: - `GENERATE_PROJECT_FUNNEL_CORRELATION_INSIGHT` to create correlation insights - `RETRIEVE_PROJECT_FUNNEL_CORRELATION_INSIGHTS` to retrieve correlation insights - `RETRIEVE_OR_DELETE_PROJECT_PERSONS_FUNNEL_DATA` for general funnel persons data This action requires additional query parameters beyond project_id to specify the funnel configuration (events, date ranges, correlation type, etc.) which are not currently defined in the request schema.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve person property values

**Slug:** `POSTHOG_RETRIEVE_PERSON_VALUES_BY_PROJECT`

Retrieve unique values for a specific person property across all persons in a project. Returns a list of distinct values for the specified property key, along with the count of persons who have that value. Useful for understanding the distribution of person properties like cities, countries, email domains, or any custom person property. Example use cases: - Get all unique cities where users are located ($geoip_city_name) - Get all unique email domains in your user base (extract from email property) - Get distribution of any custom person property Note: For person creation or updates, use the capture API or SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | The person property key to retrieve values for. This is a required parameter and cannot be empty. Examples: 'email', '$geoip_city_name', '$geoip_country_name', '$initial_referrer', 'name', or any custom person property key. |
| `format` | string ("csv" | "json") | No | Output format for the response. Defaults to JSON if not specified. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline destination activity

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_ACTIVITY`

Retrieve activity details for pipeline destinations within an organization. **Parameters:** - `organization_id` (required): UUID-formatted organization identifier **Returns:** JSON object with pipeline destination activity data including plugin IDs, names, versions, update information, and configuration details. **Note:** This endpoint requires session-based authentication and does not support Personal API Key access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The UUID of the organization to retrieve pipeline destination activity for. Format: UUID string (e.g., '019c0f24-2413-0000-bbbc-d276c57e0dbb') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline destination config details

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_CONFIG_DETAILS`

Retrieve details of a specific pipeline destination config for a project by its ID. Requires project ID and destination config ID. Supports PersonalAPIKeyAuth for read access. Responds with config details including plugin info, status, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin config. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline destination details

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_DETAILS`

Fetch a pipeline destination's details by ID and organization UUID, using a PersonalAPIKeyAuth with read access to plugins. Returns JSON with plugin info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline destination plugin details

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_PLUGIN_DETAILS`

Retrieve details of a specific pipeline destination plugin within an organization by its unique ID. The response includes various properties like name, description, URL, and plugin type for the given organization UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline frontend app activity

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_ACTIVITY`

Retrieve activity details for pipeline front-end apps within a specified organization by organization ID. Returns JSON object with app properties such as ID, type, name, and configuration. UUID path parameter required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline frontend app details

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_DETAILS`

Retrieve detailed information about a specific pipeline frontend app within an organization. Pipeline frontend apps are site apps that inject code into websites to provide features like notification bars, bug reporters, pineapple mode, and early access features. This action returns comprehensive details including the app's configuration schema, version information, capabilities, and metadata. Use LIST_ORGANIZATION_S_PIPELINE_FRONTEND_APPS to discover available app IDs first, then use this action to get detailed information about a specific app. Required parameters: - organization_id (UUID): Use RETRIEVE_CURRENT_USER_PROFILE to get your organization ID - id (integer): The unique app ID from the list action

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique integer ID of the pipeline frontend app to retrieve. Use LIST_ORGANIZATION_S_PIPELINE_FRONTEND_APPS to discover available app IDs. |
| `organization_id` | string | Yes | Organization UUID. The organization that contains the frontend app. Use RETRIEVE_CURRENT_USER_PROFILE to get your organization ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline frontend app source details

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_SOURCE_DETAILS`

Retrieve details for a specific pipeline frontend app's source by its ID within an organization. Requires an integer ID of the app and UUID of the organization. Returns JSON object with app properties.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline frontend plugin config

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_PLUGIN_CONFIG`

Retrieve the frontend-specific configuration for a pipeline frontend app by its config ID and project ID. This endpoint returns only the client-side configuration that the frontend app needs to run in the browser, such as site app settings, UI customization options, and feature toggles. This is different from the full config endpoint which includes server-side details like enabled status, order, and timestamps. Pipeline frontend apps are plugins that extend PostHog's UI with custom visualizations, site apps, notification bars, and other frontend components. Returns: A configuration object with frontend-specific settings. The structure varies depending on the type of frontend app (e.g., Notification Bar, Pineapple Mode, Early Access Features, etc.). Raises: ExecutionFailed with 404 status code if the config doesn't exist or 403/401 if you don't have permission to access it. Permissions required: Access to the project and pipeline frontend app configs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying the pipeline frontend app config. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline import apps activity

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_IMPORT_APPS_ACTIVITY`

Retrieve activity details of pipeline import apps for a given organization. Requires 'organization_id' (UUID). Returns app ID, type, name, URL, and other metadata. Supports 'local', 'custom', 'repository', 'source', and 'inline' plugin types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline plugin details by id

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_PLUGIN_DETAILS_BY_ID`

Retrieve detailed information about a specific pipeline transformation plugin by ID. Returns comprehensive plugin details including: - Plugin type (inline/custom), name, and description - Configuration schema for setting up the plugin - Capabilities (supported methods like processEvent, setupPlugin) - Version information (tag, latest_tag) - Organization ownership details - Availability for Hog function migration Use this to understand how to configure a pipeline transformation before creating a configuration for it. Requires organization-level access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique integer ID of the pipeline transformation plugin to retrieve. Obtain from LIST_ORGANIZATION_S_PIPELINE_TRANSFORMATIONS. |
| `organization_id` | string | Yes | UUID of the organization. Get from RETRIEVE_CURRENT_USER_PROFILE response (organization.id field). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Pipeline Plugin Source

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_PLUGIN_SOURCE`

Retrieve the source details of a pipeline transformation for a specific plugin by ID within an organization. Access plugin metadata, like its type, URL, and config, relevant to organizing and managing pipeline operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve pipeline transformation frontend config

**Slug:** `POSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_FRONTEND_CONFIG`

Retrieve the frontend configuration details for a specific pipeline transformation by ID within a given project. This endpoint requires the project ID and transformation config ID in the path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin config. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve plugin source details

**Slug:** `POSTHOG_RETRIEVE_PLUGIN_SOURCE_DETAILS`

Retrieve plugin source details by organization and plugin ID. Requires integer 'id' for the plugin and 'organization_id' as UUID. Responds with plugin attributes including type, name, and URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve plugin update info

**Slug:** `POSTHOG_RETRIEVE_PLUGIN_UPDATE_INFO`

This endpoint retrieves update information for a specific plugin within an organization's pipeline frontend app by its integer ID and the organization's UUID. It returns details such as plugin type, name, and latest version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve plugin update status

**Slug:** `POSTHOG_RETRIEVE_PLUGIN_UPDATE_STATUS`

Retrieve the latest update status for a specific plugin, identified by its integer ID, within an organization specified by UUID. Check compatibility and change logs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this plugin. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project action details by id

**Slug:** `POSTHOG_RETRIEVE_PROJECT_ACTION_DETAILS_BY_ID`

Get details on a project action by ID. Supports JSON/CSV format via query. Needs 'project_id' and 'id' path parameters. Secured by PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this action. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project activity details

**Slug:** `POSTHOG_RETRIEVE_PROJECT_ACTIVITY_DETAILS`

Retrieve the activity log for a specified project, showing recent changes and events. Returns a paginated list of activity entries including user actions, system events, and changes to resources like dashboards, feature flags, insights, cohorts, and other entities. Each entry includes details about what changed, who made the change, timestamps, and whether it was a user or system action. Useful for auditing project changes, tracking team activity, and understanding the history of modifications to your PostHog project resources. Requires a `project_id`. Use the LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS action to obtain available project IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project activity insights

**Slug:** `POSTHOG_RETRIEVE_PROJECT_ACTIVITY_INSIGHTS`

Retrieve the activity log history for insights in a specific project. Returns a paginated list of all insight-related activities (created, updated, deleted) with details about who performed each action and when. Useful for auditing changes, tracking insight modifications, and understanding insight usage patterns. Supports both JSON (default, structured data) and CSV formats for export. Requires an API key with activity_log:read permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Response format: 'json' returns structured JSON data (default), 'csv' returns CSV-formatted text. Use CSV for spreadsheet exports. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project activity log with pagination

**Slug:** `POSTHOG_RETRIEVE_PROJECT_ACTIVITY_LOG_WITH_PAGINATION`

Retrieve a project's activity log with cursor-based pagination. Returns activities like resource creation, updates, and deletions with details about the user who performed the action, timestamps, and change history. Use the cursor parameter from the 'next' field to fetch subsequent pages of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pagination cursor for fetching subsequent pages. Extract from 'next' URL in previous response. Leave empty for first page. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project annotation details

**Slug:** `POSTHOG_RETRIEVE_PROJECT_ANNOTATION_DETAILS`

Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this annotation. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project cohort details

**Slug:** `POSTHOG_RETRIEVE_PROJECT_COHORT_DETAILS`

Retrieve detailed information about a specific cohort within a project using its ID. Requires project ID and cohort ID; returns cohort details including name, creator info, and status. Auth: PersonalAPIKeyAuth with cohort:read permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this cohort. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project cohorts activity log

**Slug:** `POSTHOG_RETRIEVE_PROJECT_COHORTS_ACTIVITY_LOG`

Retrieve activity log for a specific project's cohorts. Requires a project_id and PersonalAPIKeyAuth with activity_log:read permission. Response includes cohort details and creator info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project cohorts with pagination

**Slug:** `POSTHOG_RETRIEVE_PROJECT_COHORTS_WITH_PAGINATION`

Retrieve a paginated list of cohorts for a specific project using `project_id`. Supports `limit` and `offset` query params to customize the response. Requires `PersonalAPIKeyAuth` with `cohort:read` permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `offset` | integer | No | The initial index from which to return the results. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project early access feature details

**Slug:** `POSTHOG_RETRIEVE_PROJECT_EARLY_ACCESS_FEATURE_DETAILS`

Retrieve details of a specific early access feature in a project by ID. Requires project_id and feature UUID. Must have 'early_access_feature:read' permission. Returns feature details including status, flag info, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this early access feature. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project event details by id

**Slug:** `POSTHOG_RETRIEVE_PROJECT_EVENT_DETAILS_BY_ID`

Retrieve details for a specific event by ID within a project. Supports CSV or JSON format. Requires project_id in path and adheres to PersonalAPIKeyAuth for security.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project event values

**Slug:** `POSTHOG_RETRIEVE_PROJECT_EVENT_VALUES`

Retrieve event values for a specific project by ID. Supports querying in CSV or JSON format. Requires a project_id and personal API key with query:read permission. Responds with event details such as ID, distinct_id, properties, etc.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | The event property key to retrieve values for. This is a required parameter and cannot be empty. Examples: '$browser', '$geoip_city_name', '$os', 'distinct_id', or any custom event property key. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project experiment results

**Slug:** `POSTHOG_RETRIEVE_PROJECT_EXPERIMENT_RESULTS`

Retrieve experiment timeseries results within a project by project and experiment ID. Aggregates daily results into a timeseries format for frontend compatibility. Requires project_id and experiment id in the path, plus metric_uuid and fingerprint query parameters. Returns experiment timeseries details in JSON, with authentication via PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `fingerprint` | string | Yes | The fingerprint of the metric configuration. Required. |
| `metric_uuid` | string | Yes | The UUID of the metric to retrieve results for. Required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project export details

**Slug:** `POSTHOG_RETRIEVE_PROJECT_EXPORT_DETAILS`

Retrieve detailed info on a specific export of a project using its unique ID. Requires project ID and supports various export formats like PNG, PDF, CSV, and XLSX. Auth: PersonalAPIKeyAuth with export:read scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this exported asset. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project funnel correlation insights

**Slug:** `POSTHOG_RETRIEVE_PROJECT_FUNNEL_CORRELATION_INSIGHTS`

Retrieve funnel correlation insights for a specific project. Analyzes which events or properties correlate with conversion success or failure in a funnel. Requires defining a funnel with at least 2 steps via 'events' or 'actions'. Returns correlation data showing which factors positively or negatively impact funnel conversion rates. Supports JSON/CSV output formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | No | List of events to include in the funnel. Each event should have 'id' (event name), 'type' ('events'), and 'order' (step number starting from 0). At least 2 steps are required. One of 'events' or 'actions' is required. |
| `format` | string ("csv" | "json") | No | Response format: 'json' or 'csv'. |
| `actions` | array | No | List of actions to include in the funnel. Each action should have 'id' (action ID), 'type' ('actions'), and 'order' (step number). One of 'events' or 'actions' is required. |
| `date_to` | string | No | End date for the funnel analysis. Can be a date '2021-01-01' or relative like '-7d', '-1m', 'mStart', 'yStart'. |
| `insight` | string | No | Type of insight. For funnel correlation, should be 'FUNNELS'. |
| `date_from` | string | No | Start date for the funnel analysis. Can be a date '2021-01-01' or relative like '-7d', '-1m', 'mStart', 'yStart'. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `filter_test_accounts` | boolean | No | Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.  |
| `funnel_window_interval` | integer | No | Funnel conversion window size (used with funnel_window_interval_type). Defaults to 14 days. |
| `funnel_correlation_type` | string ("events" | "properties" | "event_with_properties") | No | Type of correlation to analyze: 'events', 'properties', or 'event_with_properties'. |
| `funnel_window_interval_type` | string | No | Unit for funnel window interval: 'day', 'hour', 'minute', 'week', or 'month'. Defaults to 'day'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project group details by key and type

**Slug:** `POSTHOG_RETRIEVE_PROJECT_GROUP_DETAILS_BY_KEY_AND_TYPE`

Retrieves specified group details within a project by group key and type index. Requires 'group_key', 'group_type_index', and 'project_id'. Responds with group details, including creation timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_key` | string | Yes | Specify the key of the group to find |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `group_type_index` | integer | Yes | Specify the group type to find |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project insight activity data

**Slug:** `POSTHOG_RETRIEVE_PROJECT_INSIGHT_ACTIVITY_DATA`

Retrieve insights activity for a specific project and insight ID, offering data in JSON or CSV format. Requires project_id and insight id in the path, with optional data format query. Secure access via PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this insight. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project insight details

**Slug:** `POSTHOG_RETRIEVE_PROJECT_INSIGHT_DETAILS`

Retrieve details for a specific project insight by ID, with options to format as JSON/CSV, request refresh, and specify dashboard context. Supports PersonalAPIKeyAuth with insight read access. Responses include metadata, results, and caching info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this insight. |
| `format` | string ("csv" | "json") | No | Format |
| `refresh` | boolean | No |                  The client can request that an insight be refreshed by setting the `refresh=true` parameter.                 The server will then decide if the data should or not be refreshed based on a set of heuristics                 meant to determine the staleness of cached data. The result will contain as `is_cached` field                 that indicates whether the insight was actually refreshed or not through the request.  |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `from_dashboard` | integer | No |  When loading an insight for a dashboard pass a `from_dashboard` query parameter containing the dashboard ID e.g. `"/api/projects/{team_id}/insights/{insight_id}?from_dashboard={dashboard_id}"` Insights can be added to more than one dashboard, this allows the insight to be loaded in the correct context. Using the correct cache and enriching the response with dashboard specific config (e.g. layouts or colors)  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project insights with pagination

**Slug:** `POSTHOG_RETRIEVE_PROJECT_INSIGHTS_WITH_PAGINATION`

The GET `/api/projects/{project_id}/insights/` endpoint retrieves a paginated list of insights for a specified project. Filter by creator, response format (CSV/JSON), and use limit/offset for result batching. Requires `insight:read` permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page. |
| `format` | string ("csv" | "json") | No | Format |
| `offset` | integer | No | The initial index from which to return the results. |
| `short_id` | string | No | Short Id |
| `created_by` | integer | No | Created By |
| `project_id` | string | Yes | Numeric project ID (e.g., '12345'). This must be the integer ID as a string, not the project UUID or slug. To find the numeric ID, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project member details by uuid

**Slug:** `POSTHOG_RETRIEVE_PROJECT_MEMBER_DETAILS_BY_UUID`

Retrieve detailed information about a specific user's membership level and status within a project by their UUID. Access project members' data, roles, and timestamps. (GET /api/projects/{project_id}/explicit_members/{uuid}) Note: This endpoint only works for projects with access control enabled (private projects). If the project does not have access control enabled, the API will return a 404 "Endpoint not found" error. Access control is an Enterprise feature that can be enabled in Project Settings > Access Control.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint only works for projects with access control enabled (private projects). Access control is an Enterprise feature. |
| `parent__membership__user__uuid` | string | Yes | Parent Membership User Uuid |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project person activity

**Slug:** `POSTHOG_RETRIEVE_PROJECT_PERSON_ACTIVITY`

This endpoint allows reading and deleting individuals. For creating or updating, use the capture API, `$set`/`$unset` properties, or SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project session values

**Slug:** `POSTHOG_RETRIEVE_PROJECT_SESSION_VALUES`

Retrieve session values for a specified project. Pass the project_id in the URL path to obtain the information. Only the project's ID is required as a parameter. No response body for the 200 OK status code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Specify the session property key to find values for. Examples: $channel_type, $session_duration, $is_bounce, $entry_pathname, etc. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project subscription details

**Slug:** `POSTHOG_RETRIEVE_PROJECT_SUBSCRIPTION_DETAILS`

Retrieve a specific subscription for a project, identified by 'project_id' and 'id'. Requires valid API key with read access. Supports GET method, returns subscription details including frequency, type, and creator info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this subscription. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve project trend insights

**Slug:** `POSTHOG_RETRIEVE_PROJECT_TREND_INSIGHTS`

Retrieves saved trend insights from a PostHog project. Returns a list of all trend insights or a specific insight by short_id. Supports pagination via limit/offset and CSV/JSON output formats. Use this to access previously created trend analysis reports. For creating new trend insights, use the POST trends endpoint instead. Requires PersonalAPIKeyAuth authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return. Use for pagination. |
| `format` | string ("csv" | "json") | No | Response format - csv or json. Default is json. |
| `offset` | integer | No | Number of results to skip. Use for pagination. |
| `short_id` | string | No | Short ID of a specific saved insight to retrieve. This is the alphanumeric identifier that appears in the insight URL (e.g., 'abc123'). If not provided, returns all trend insights for the project. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve properties and events association

**Slug:** `POSTHOG_RETRIEVE_PROPERTIES_AND_EVENTS_ASSOCIATION`

Allows a caller to provide a list of event names and a single property name Returns a map of the event names to a boolean representing whether that property has ever been seen with that event_name

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `event_names` | string | Yes | A comma-separated list of event names to check for property association. |
| `property_name` | string | Yes | The property name to check if it has been seen together with the events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve property definition details

**Slug:** `POSTHOG_RETRIEVE_PROPERTY_DEFINITION_DETAILS`

Retrieve details of a specific property definition by UUID within a project. Requires project_id and property definition id. Security: PersonalAPIKeyAuth with read access. No response body provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this property definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve related project groups

**Slug:** `POSTHOG_RETRIEVE_RELATED_PROJECT_GROUPS`

Retrieve related groups for a specific project and user. Requires 'project_id' (path), 'group_type_index', and user 'id' (query). Returns group details with type, key, and creation date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Specify the id of the user to find groups for |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `group_type_index` | integer | Yes | Specify the group type to find |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Retention Insights (Deprecated)

**Slug:** `POSTHOG_RETRIEVE_RETENTION_INSIGHTS`

DEPRECATED: Use POSTHOG_CREATE_RETRIEVE_RETENTION_INSIGHTS_FOR_PROJECT instead. Retrieve retention insights for a specified project using PostHog's Query API. Analyzes how users return over time based on specified events or actions. Uses the /api/projects/{project_id}/query/ endpoint with a RetentionQuery. Requires a project ID and authenticated access with 'insight:read' permission. If no query is provided, returns default retention data for $pageview events over 7 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | object | No | A RetentionQuery object defining how to analyze user retention over time. Retention analysis tracks users who performed an initial event (targetEntity) and returned to perform a follow-up event (returningEntity) within specified time intervals. If not provided, defaults to analyzing $pageview retention over 7 days. Query Structure: 'kind' (required) must be 'RetentionQuery'. 'retentionFilter' (required) contains: 'retentionType' ('retention_first_time' for first occurrence cohorts, 'retention_recurring' for any occurrence), 'totalIntervals' (number of time periods to analyze), 'period' ('Hour', 'Day', 'Week', or 'Month'), 'targetEntity' (initial event to enter cohort), 'returningEntity' (event to count as retained). Optional fields: 'dateRange' with 'date_from'/'date_to', 'filterTestAccounts' boolean, 'properties' array. |
| `refresh` | string | No | Whether to refresh the query results. Options: 'async', 'blocking', 'force_async', 'force_blocking', 'force_cache', 'lazy_async'. |
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve session property definitions

**Slug:** `POSTHOG_RETRIEVE_SESSION_PROPERTY_DEFINITIONS`

Retrieve property definitions for a specific project by providing the project's ID. Access this GET endpoint at `/api/projects/{project_id}/sessions/property_definitions/`. Project ID is mandatory. No response body is returned upon a successful call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve session recording details

**Slug:** `POSTHOG_RETRIEVE_SESSION_RECORDING_DETAILS`

Retrieve detailed information about a specific session recording by providing the session's UUID and associated project ID. The response includes metrics such as duration, activity, timestamps, and user data. Authentication is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this session recording. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve session recording error clusters

**Slug:** `POSTHOG_RETRIEVE_SESSION_RECORDING_ERROR_CLUSTERS`

Retrieve error clusters from session recordings for a specified project. This endpoint provides details on user interactions, console logs, and activity times in JSON format, requiring the project ID in the path.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve recordings from playlist

**Slug:** `POSTHOG_RETRIEVE_SESSION_RECORDING_PLAYLIST_DETAILS`

Retrieve the list of session recordings within a playlist. Returns paginated results containing recording details like duration, activity counts, and timestamps. Use this to access recordings that have been added to a specific playlist in a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `short_id` | string | Yes | The short ID of the session recording playlist to retrieve recordings from. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve session recording properties

**Slug:** `POSTHOG_RETRIEVE_SESSION_RECORDING_PROPERTIES_BY_PROJECT_ID`

Retrieve properties of session recordings for a given project by ID, including activity metrics, timestamps, and participant details. Requires project_id in the path. Returns JSON data with recording details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve session recording snapshots

**Slug:** `POSTHOG_RETRIEVE_SESSION_RECORDING_SNAPSHOTS`

Snapshots for a session can be loaded from S3 (if old) or Redis (if recent). Clients call the API without a source to get supported sources, then per source for snapshots. API v1 is deprecated; ClickHouse support removed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this session recording. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve specific batch export details

**Slug:** `POSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_DETAILS`

Retrieve details of a specific batch export for an organization by its UUID. Requires a PersonalAPIKeyAuth with 'batch_export:read' permission. Responses include export details like name, model, destination, interval, and more.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this batch export. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve specific batch export run details

**Slug:** `POSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_RUN_DETAILS`

Retrieve details for a specific batch export run within a project by ID. Requires a UUID for batch_export_id and run ID. Provides run status, record count, timestamps, latest error, and intervals. Security: PersonalAPIKeyAuth.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this batch export run. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `batch_export_id` | string | Yes | Batch Export Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve specific domain details

**Slug:** `POSTHOG_RETRIEVE_SPECIFIC_DOMAIN_DETAILS`

Retrieve complete details of a specific authentication domain within an organization by its UUID. Returns domain verification status, SAML SSO configuration, JIT provisioning settings, and SSO enforcement policies. Use this to check if a domain has been verified via DNS, view SAML configuration details, or audit authentication settings for a specific domain. Returns 200 with domain details on success, 404 if the domain doesn't exist or you don't have access. Requires authentication with `organization:read` scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the domain to retrieve. Domain IDs can be obtained from the list domains endpoint. |
| `organization_id` | string | Yes | UUID of the PostHog organization that owns the domain. Found in organization settings or via the organizations API endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve specific exported asset content

**Slug:** `POSTHOG_RETRIEVE_SPECIFIC_EXPORTED_ASSET_CONTENT`

Retrieve the content of a specific exported asset by ID within a project. Requires 'export:read' permission. Supports fetching details like creation time, format (PNG, PDF, CSV, Excel), etc.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this exported asset. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve specific historical plugin export

**Slug:** `POSTHOG_RETRIEVE_SPECIFIC_HISTORICAL_PLUGIN_EXPORT`

Retrieve historical export data for a specific plugin configuration within a project. Requires project, plugin config, and export item IDs. Auth via PersonalAPIKeyAuth. No body in 200 response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `plugin_config_id` | string | Yes | Plugin Config Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve specific pipeline frontend app config

**Slug:** `POSTHOG_RETRIEVE_SPECIFIC_PIPELINE_FRONTEND_APP_CONFIG`

Retrieve the configuration details of a specific pipeline frontend app by providing its unique ID and the associated project ID. Pipeline frontend apps are plugins that extend PostHog's UI with custom visualizations, dashboards, and other frontend components. Returns config details including: - id: Unique identifier for the config - enabled: Whether the app is active - order: Display order in the UI - plugin: Plugin ID and metadata - config: Plugin-specific configuration - filters: Event filters applied - created_at, updated_at: Timestamps Note: Returns 404 error if the config ID doesn't exist in the specified project. Permissions required: 'plugin:read'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this pipeline frontend app config. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve specific project dashboard details

**Slug:** `POSTHOG_RETRIEVE_SPECIFIC_PROJECT_DASHBOARD_DETAILS`

Retrieve details of a specific dashboard within a project. Requires a dashboard ID & project ID, and returns information such as dashboard properties, owner, and access levels. Auth: PersonalAPIKeyAuth[dashboard:read].

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this dashboard. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve survey activity logs

**Slug:** `POSTHOG_RETRIEVE_SURVEY_ACTIVITY_LOGS`

Retrieve activity logs for specific survey in a project, identified by UUIDs. Requires valid API key with 'activity_log:read' permissions. Supports JSON response detailing survey's properties, types, and creator info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve survey details with uuid and project id

**Slug:** `POSTHOG_RETRIEVE_SURVEY_DETAILS_WITH_UUID_AND_PROJECT_ID`

Retrieve survey details using survey UUID and associated project ID. Supports secure access with 'PersonalAPIKeyAuth'. Returns survey name, type, linking, targeting flags, creator info, and questions with branching logic descriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve survey responses count by project id

**Slug:** `POSTHOG_RETRIEVE_SURVEY_RESPONSES_COUNT_BY_PROJECT_ID`

Retrieve the count of survey responses for a specific project by its ID. It requires the project_id parameter and returns details like the survey type, linked flags, and creator info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve unsubscribed pipeline configs

**Slug:** `POSTHOG_RETRIEVE_UNSUBSCRIBED_PIPELINE_CONFIGS`

Retrieve export unsubscribe configurations for an organization's pipeline destinations. Returns a list of unsubscribe configurations defining how users can opt out of data exports to destinations (e.g., S3, BigQuery, Snowflake, Redshift). Each config includes an ID, plugin type, and settings. Required: organization_id (UUID). Use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE or POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to get it. **IMPORTANT**: This endpoint requires session-based authentication and does NOT support Personal API Key access. It may return a 403 error stating "This action does not support Personal API Key access" when used with API keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | string | Yes | The UUID of the organization to retrieve export unsubscribe configurations for (e.g., '019c0f24-2413-0000-bbbc-d276c57e0dbb'). Use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE or POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to get valid organization IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve user profile and team details

**Slug:** `POSTHOG_RETRIEVE_USER_PROFILE_AND_TEAM_DETAILS`

Fetch user profile info including team, organization, and notifications. Non-staff users can only retrieve their own profile using '@me' as the uuid parameter. Staff users can retrieve any user's profile using their actual UUID. Returns JSON with name, email, teams, organizations, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uuid` | string | Yes | The user identifier. Use '@me' to retrieve the current authenticated user's profile (recommended for non-staff users). Staff users can use an actual UUID to retrieve other users' profiles. Non-staff users attempting to use a UUID other than '@me' will receive a permission denied error. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retry batch export run

**Slug:** `POSTHOG_RETRY_BATCH_EXPORT_RUN`

Tool to retry a failed or incomplete batch export run. Uses the same backfill mechanism as batch export backfills. Use when you need to re-execute a specific batch export run that failed or needs to be re-processed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this batch export run. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `batch_export_id` | string | Yes | The BatchExport this run belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke organization invite

**Slug:** `POSTHOG_REVOKE_ORGANIZATION_INVITE`

Delete an organization invite by its UUID. Requires a valid PersonalAPIKeyAuth with organization member write permission. No response body returned on success (HTTP 204).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this organization invite. |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run endpoint

**Slug:** `POSTHOG_RUN_ENDPOINT`

Tool to execute a PostHog endpoint with optional materialization and filtering. Endpoints can be HogQL queries, insights (Trends, Funnels, etc.), or other query types. Use this when you need to run a predefined endpoint with custom parameters or filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | URL-safe name for the endpoint to execute |
| `debug` | boolean | No | Whether to include debug information (such as the executed HogQL) in the response. |
| `limit` | integer | No | Maximum number of results to return. If not provided, returns all results. |
| `refresh` | string ("cache" | "force" | "direct") | No | Refresh mode for endpoint execution |
| `version` | integer | No | Specific endpoint version to execute. If not provided, the latest version is used. |
| `variables` | object | No | Variables to parameterize the endpoint query. The key is the variable name and the value is the variable value. For HogQL endpoints: Keys must match a variable code_name defined in the query (referenced as {variables.code_name}). For non-materialized insight endpoints: date_from and date_to are built-in variables that filter the date range. For materialized insight endpoints: Use the breakdown property name as the key to filter by breakdown value. Unknown variable names will return a 400 error. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `client_query_id` | string | No | Client provided query ID. Can be used to retrieve the status or cancel the query. |
| `filters_override` | object | No | Dashboard filter for overriding endpoint filters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Split person entities in project

**Slug:** `POSTHOG_SPLIT_PERSON_ENTITIES_IN_PROJECT`

This endpoint allows reading and deleting persons; for creation or updates, use the capture API, `$set`/`$unset` properties, or SDKs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A unique UUID value identifying this person. |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `distinct_ids` | array | No | Distinct Ids to split off from this person. If not provided, all distinct IDs except one will be split. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create error tracking symbol sets bulk start upload

**Slug:** `POSTHOG_START_ERROR_TRACKING_SYMBOL_SETS_BULK_UPLOAD`

Tool to initiate bulk upload of error tracking symbol sets for a PostHog project. Use when you need to start uploading debug symbols for error tracking and source map resolution. This endpoint initializes the bulk upload process and returns an ID mapping for tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID identifier for the symbol set (e.g., '550e8400-e29b-41d4-a716-446655440000'). |
| `ref` | string | Yes | Git reference (branch, tag, or commit) for the symbol set (e.g., 'main', 'v1.0.0', 'develop'). |
| `release` | string | Yes | Release version or identifier for the symbol set (e.g., 'v1.0.0', '1.2.3'). |
| `team_id` | integer | Yes | Team ID (also referred to as project ID in some contexts) associated with the symbol set. |
| `last_used` | string | No | ISO 8601 timestamp indicating when the symbol set was last used. |
| `created_at` | string | Yes | ISO 8601 timestamp indicating when the symbol set was created (e.g., '2026-02-16T10:00:00Z'). |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `storage_ptr` | string | No | Optional storage pointer reference for the symbol set location. |
| `failure_reason` | string | No | Optional reason for failure if the symbol set upload failed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create error tracking symbol sets start upload

**Slug:** `POSTHOG_START_ERROR_TRACKING_SYMBOL_SET_UPLOAD`

Tool to initiate symbol set upload session for error tracking in PostHog. Use when you need to upload symbol files for stack trace symbolication. Returns a presigned S3 URL where the symbol file chunk should be uploaded. The endpoint is part of a multi-step upload process.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID identifier for the symbol set being uploaded |
| `ref` | string | Yes | Reference identifier (e.g., git branch name or commit ref) for the symbol set |
| `release` | string | Yes | Release version associated with the symbol set |
| `team_id` | integer | Yes | Team ID associated with the symbol set. Usually matches the project ID. |
| `chunk_id` | string | Yes | Chunk identifier for the upload session. Used to track individual file chunks during upload. |
| `last_used` | string | No | ISO 8601 timestamp indicating when the symbol set was last used for symbolication |
| `created_at` | string | Yes | ISO 8601 timestamp indicating when the symbol set was created |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `storage_ptr` | string | No | Storage pointer for the symbol set data location |
| `failure_reason` | string | No | Optional reason for failure if the symbol set processing has failed previously |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Summarize survey responses

**Slug:** `POSTHOG_SUMMARIZE_SURVEY_RESPONSES`

Tool to generate an AI-powered summary of survey responses for a specific question. Use when you need to analyze and summarize feedback from survey respondents for a particular question.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `question_index` | integer | Yes | The index of the question to summarize responses for (0-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Translate text

**Slug:** `POSTHOG_TRANSLATE_TEXT`

Tool to translate text to a target language using PostHog's LLM analytics translation endpoint. Use when you need to translate content for analytics or internationalization purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text to translate |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `target_language` | string | Yes | Target language code (e.g., 'es' for Spanish, 'fr' for French, 'de' for German) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger project export with format option

**Slug:** `POSTHOG_TRIGGER_PROJECT_EXPORT_WITH_FORMAT_OPTION`

The `/api/projects/{project_id}/exports/` endpoint triggers a project export, requiring `project_id` and `export_format`. It accepts JSON, form-encoded, and multipart data, responding with a 201 code and export information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `insight` | integer | No | Insight ID to export. Either dashboard or insight must be provided. |
| `dashboard` | integer | No | Dashboard ID to export. Either dashboard or insight must be provided. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `export_format` | string ("image/png" | "application/pdf" | "text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") | Yes | * `image/png` - image/png * `application/pdf` - application/pdf * `text/csv` - text/csv * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet  |
| `export_context` | string | No | Export Context |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unarchive survey response

**Slug:** `POSTHOG_UNARCHIVE_SURVEY_RESPONSE`

Tool to unarchive a single survey response. Use when you need to restore a previously archived survey response to make it visible again in survey analytics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `response_uuid` | string | Yes | UUID string identifying the survey response to unarchive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unpause Batch Export

**Slug:** `POSTHOG_UNPAUSE_BATCH_EXPORT`

Tool to unpause a paused batch export in PostHog. Use when you need to resume a previously paused batch export to restart data exports.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to unpause |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unpause Organization Batch Export

**Slug:** `POSTHOG_UNPAUSE_ORGANIZATION_BATCH_EXPORT`

Tool to unpause a paused batch export at the organization level. Use when you need to resume a previously paused organization-level batch export to restart data exports.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to unpause |
| `organization_id` | string | Yes | Organization ID of the organization containing the batch export |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update alert (full replacement)

**Slug:** `POSTHOG_UPDATE_ALERT`

Tool to fully update an existing alert configuration in PostHog using PUT method. Use when you need to completely replace alert settings including name, enabled status, insight, thresholds, and subscribed users. Unlike PATCH, this performs a full replacement of the alert configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this alert configuration. |
| `name` | string | Yes | Alert name. Maximum 255 characters. |
| `config` | object | No | Alert configuration settings |
| `enabled` | boolean | Yes | Whether the alert is enabled |
| `insight` | integer | Yes | Insight ID monitored by this alert. The insight must exist in the same project. |
| `condition` | object | No | Alert condition configuration |
| `threshold` | object | Yes | Alert threshold configuration defining when alert triggers |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `skip_weekend` | boolean | No | Whether to skip checks during weekends |
| `snoozed_until` | string | No | ISO 8601 timestamp until which the alert is snoozed |
| `subscribed_users` | array | Yes | List of user IDs to subscribe to this alert. Can be an empty list if no users should be subscribed. |
| `calculation_interval` | string | No | Calculation interval for the alert (can be string or object) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update annotation details

**Slug:** `POSTHOG_UPDATE_ANNOTATION_DETAILS`

Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this annotation. |
| `scope` | string ("dashboard_item" | "dashboard" | "project" | "organization") | No | * `dashboard_item` - insight * `dashboard` - dashboard * `project` - project * `organization` - organization  |
| `content` | string | No | Content |
| `deleted` | boolean | No | Deleted |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | Updated At |
| `date_marker` | string | No | Date Marker |
| `dashboard_id` | integer | No | Dashboard Id |
| `insight_name` | string | No | Insight Name |
| `creation_type` | string ("USR" | "GIT") | No | * `USR` - user * `GIT` - GitHub |
| `dashboard_item` | integer | No | Dashboard Item |
| `dashboard_name` | string | No | Dashboard Name |
| `insight_short_id` | string | No | Insight Short Id |
| `insight_derived_name` | string | No | Insight Derived Name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update batch export

**Slug:** `POSTHOG_UPDATE_BATCH_EXPORT`

Tool to update an existing batch export configuration in PostHog. Use when you need to modify batch export settings like name, schedule, destination, or filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to update |
| `name` | string | No | A human-readable name for this batch export |
| `model` | string | No | Which model this batch export is exporting (events, persons, or sessions) |
| `end_at` | string | No | Time after which batch export runs won't be triggered (ISO 8601 datetime) |
| `paused` | boolean | No | Whether this batch export is paused or not |
| `schema` | object | No | Schema of custom fields to select when exporting data |
| `filters` | object | No | Additional filters to apply to the exported data |
| `interval` | string ("hour" | "day" | "week" | "every 5 minutes") | No | Batch export run interval options |
| `start_at` | string | No | Time before which batch export runs won't be triggered (ISO 8601 datetime) |
| `timezone` | string | No | Timezone for scheduling the batch export |
| `offset_day` | integer | No | Day offset for weekly exports (0=Sunday, 6=Saturday) |
| `destination` | object | No | Batch export destination configuration |
| `hogql_query` | string | No | Custom HogQL query for filtering exported data |
| `offset_hour` | integer | No | Hour offset for daily exports (0-23) |
| `organization_id` | string | Yes | The UUID of the organization containing the batch export |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Profile Config

**Slug:** `POSTHOG_UPDATE_CUSTOMER_PROFILE_CONFIG`

Update a customer profile configuration by completely replacing it with new data via PUT request. Use when you need to update the entire customer profile config object including all fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this customer profile config. |
| `scope` | string ("person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4") | Yes | Scope of the profile configuration (person or group_0 through group_4) |
| `content` | object | No | Content configuration for the customer profile. Can be any JSON object with arbitrary fields. |
| `sidebar` | object | No | Sidebar configuration for the customer profile. Can be any JSON object with arbitrary fields. |
| `created_at` | string | Yes | ISO 8601 timestamp when the config was created. This field is required for PUT operations. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `updated_at` | string | No | ISO 8601 timestamp when the config was last updated. Optional for PUT operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Datasets

**Slug:** `POSTHOG_UPDATE_DATASET`

Tool to update a dataset in PostHog by its ID and project ID. Use when you need to modify the name or description of an existing dataset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the dataset to update |
| `name` | string | No | Name of the dataset (max 400 characters) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |
| `description` | string | No | Description of the dataset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dataset Items

**Slug:** `POSTHOG_UPDATE_DATASET_ITEMS`

Tool to fully update a dataset item by its ID in a PostHog project using PUT method. Use when you need to replace all fields of a dataset item including dataset, input, output, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this dataset item. |
| `input` | object | No | Input data for the dataset item (e.g., prompt or question) |
| `output` | object | No | Output data for the dataset item (e.g., response or result) |
| `dataset` | string | Yes | UUID of the dataset this item belongs to |
| `deleted` | boolean | No | Whether the dataset item should be marked as deleted |
| `metadata` | object | No | Optional metadata associated with the dataset item |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `ref_trace_id` | string | No | Reference trace ID (max 255 characters) |
| `ref_source_id` | string | No | Reference source ID (max 255 characters) |
| `ref_timestamp` | string | No | Reference timestamp (ISO 8601 datetime format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Desktop Recording

**Slug:** `POSTHOG_UPDATE_DESKTOP_RECORDING`

Update desktop meeting recording details via PATCH. Use to modify meeting title, notes, status, transcripts, or AI-extracted tasks and summaries. Requires desktop_recording:write scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | UUID of the desktop recording to update |
| `notes` | string | No | Meeting notes or additional context |
| `status` | string ("recording" | "uploading" | "processing" | "ready" | "error") | No | Recording status. |
| `summary` | string | No | AI-generated summary of the meeting |
| `platform` | string ("zoom" | "teams" | "meet" | "desktop_audio" | "slack") | No | Meeting platform type. |
| `video_url` | string | No | URL to the video file (max 200 characters) |
| `project_id` | string | Yes | Project ID (environment ID) containing the recording. Find it via /api/projects/ |
| `started_at` | string | No | ISO 8601 timestamp when the recording started |
| `meeting_url` | string | No | URL to the meeting (max 200 characters) |
| `completed_at` | string | No | ISO 8601 timestamp when the recording was completed |
| `participants` | array | No | List of participant names |
| `error_message` | string | No | Error message if processing failed |
| `meeting_title` | string | No | Title of the meeting (max 255 characters) |
| `extracted_tasks` | array | No | AI-extracted tasks from the transcript |
| `transcript_text` | string | No | Full transcript text |
| `duration_seconds` | integer | No | Duration of the recording in seconds |
| `video_size_bytes` | integer | No | Size of the video file in bytes |
| `tasks_generated_at` | string | No | ISO 8601 timestamp when tasks were generated |
| `recall_recording_id` | string | No | UUID of the associated Recall recording |
| `transcript_segments` | array | No | Transcript segments with timestamps |
| `summary_generated_at` | string | No | ISO 8601 timestamp when the summary was generated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update early access project feature

**Slug:** `POSTHOG_UPDATE_EARLY_ACCESS_PROJECT_FEATURE`

This PATCH endpoint updates a specific early access project feature. It requires `project_id` and `id` (UUID) as path parameters. The body can include feature details like `name`, `description`, and `stage`. Security: `PersonalAPIKeyAuth`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `stage` | string ("draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived") | No | * `draft` - draft * `concept` - concept * `alpha` - alpha * `beta` - beta * `general-availability` - general availability * `archived` - archived  |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `documentation_url` | string | No | Documentation Url |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update endpoint

**Slug:** `POSTHOG_UPDATE_ENDPOINT`

Tool to update an existing endpoint for a PostHog project. Use when you need to replace endpoint configuration with new values. All parameters are optional. Pass version in body or ?version=N query param to target a specific version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | URL-safe name of the endpoint to update |
| `query` | object | No | Query configuration for the endpoint. Must include a 'kind' field specifying the query type (e.g., 'HogQLQuery', 'TrendsQuery', 'FunnelsQuery', etc.) |
| `version` | integer | No | Target a specific version for updates (optional, defaults to current version). Can also be passed as a query parameter ?version=N |
| `is_active` | boolean | No | Whether the endpoint is active and can be queried |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description for the endpoint to explain its purpose or usage |
| `sync_frequency` | string ("5min" | "30min" | "1hour" | "6hour" | "12hour" | "24hour" | "7day" | "30day") | No | Sync frequency options for data warehouse endpoints |
| `is_materialized` | boolean | No | Whether this endpoint's query results are materialized to S3 for faster access |
| `cache_age_seconds` | number | No | Cache age in seconds for the endpoint. If set, responses will be cached for this duration to improve performance. |
| `derived_from_insight` | string | No | Insight ID from which this endpoint is derived, if applicable |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update error tracking autocapture controls

**Slug:** `POSTHOG_UPDATE_ERROR_TRACKING_AUTOCAPTURE_CONTROL`

Tool to fully update an error tracking autocapture control configuration for a PostHog project. Use when you need to replace all settings of an existing autocapture control, including library, sample rate, URL triggers, event triggers, and match type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this error tracking auto capture controls. |
| `library` | string | Yes | Library identifier for error tracking configuration (e.g., 'web', 'javascript', 'python', 'java') |
| `match_type` | string ("all" | "any") | No | Match type for triggers: 'all' means all conditions must match, 'any' means at least one condition must match |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `sample_rate` | string | No | Sample rate for error tracking (decimal string format between -1.00 and 1.00, e.g., '0.90' for 90%) |
| `url_triggers` | array | No | List of URL patterns that trigger error tracking |
| `url_blocklist` | array | No | List of URL patterns to exclude from error tracking |
| `event_triggers` | array | No | List of event triggers that activate error tracking autocapture |
| `linked_feature_flag` | string | No | Feature flag linked to this autocapture control (can be a string ID or a feature flag object) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update evaluation

**Slug:** `POSTHOG_UPDATE_EVALUATION`

Tool to update an existing evaluation in PostHog using PUT request. Use when you need to fully replace an evaluation configuration. For partial updates, consider using the patch_evaluation action instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this evaluation. |
| `name` | string | Yes | Name of the evaluation (max 400 characters) |
| `deleted` | boolean | No | Whether the evaluation is marked as deleted |
| `enabled` | boolean | No | Whether the evaluation is enabled |
| `conditions` | object | No | Conditions configuration for when the evaluation should run |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Optional description of what this evaluation does |
| `output_type` | string ("boolean") | Yes | Output type of the evaluation. Currently supported: 'boolean' (Boolean Pass/Fail) |
| `output_config` | object | No | Output configuration settings for how results are formatted |
| `evaluation_type` | string ("llm_judge") | Yes | Type of evaluation. Currently supported: 'llm_judge' (LLM as a judge) |
| `evaluation_config` | object | No | Configuration settings for the evaluation logic (e.g., prompt for LLM judge) |
| `model_configuration` | object | No | Model configuration for the evaluation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update event definition by uuid

**Slug:** `POSTHOG_UPDATE_EVENT_DEFINITION`

Update an event definition by sending a PUT request to '/api/projects/{project_id}/event_definitions/{id}/' using the UUID and project ID, provided you have 'event_definition:write' authorization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this event definition. |
| `name` | string | Yes | The name of the event definition. |
| `tags` | array | No | Tags associated with this event definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `post_to_slack` | boolean | No | Whether to post this event to Slack. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update experiment details

**Slug:** `POSTHOG_UPDATE_EXPERIMENT`

Update an experiment by sending a PUT request with `project_id` and `id`, including new details as JSON/form data. Changes to name, description, dates, etc., allowed. `experiment:write` permission needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment. |
| `name` | string | No | Name |
| `filters` | string | No | Filters |
| `archived` | boolean | No | Archived |
| `end_date` | string | No | End Date |
| `created_at` | string | No | Created At |
| `parameters` | string | No | Parameters |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | No | Start Date |
| `updated_at` | string | No | Updated At |
| `description` | string | No | Description |
| `exposure_cohort` | integer | No | Exposure Cohort |
| `feature_flag_key` | string | Yes | Feature Flag Key (required for experiment update) |
| `secondary_metrics` | string | No | Secondary Metrics |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update experiment holdout

**Slug:** `POSTHOG_UPDATE_EXPERIMENT_HOLDOUT`

Tool to partially update an experiment holdout in a PostHog project. Use when you need to modify a holdout's name, description, or filter configuration. Updates only the fields provided in the request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment holdout. |
| `name` | string | No | Name of the experiment holdout (max 400 characters). |
| `filters` | array | No | Filter configuration for the experiment holdout (list of filter objects). |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the experiment holdout (max 400 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update experiment holdout (full)

**Slug:** `POSTHOG_UPDATE_EXPERIMENT_HOLDOUT_COMPLETE`

Tool to fully update an experiment holdout in PostHog using PUT method. Use when you need to replace all holdout configuration including name, description, and filters. All required fields must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment holdout. |
| `name` | string | Yes | Name of the experiment holdout (max 400 characters). |
| `filters` | array | Yes | List of filter configurations for the holdout. At least one filter with properties and rollout_percentage is required. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the experiment holdout (max 400 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update experiment saved metrics

**Slug:** `POSTHOG_UPDATE_EXPERIMENT_SAVED_METRIC`

Tool to update an existing experiment saved metric in PostHog. Use when you need to modify the name, description, query, or tags of a saved experiment metric. Requires the experiment saved metric ID and project ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this experiment saved metric. |
| `name` | string | Yes | Name of the experiment saved metric. |
| `tags` | array | No | Tags associated with the experiment saved metric. |
| `query` | object | Yes | Query configuration for the experiment metric. Must contain 'kind' field (e.g., 'ExperimentTrendsQuery') and a 'count_query' with series definition. |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the experiment saved metric. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update External Data Sources

**Slug:** `POSTHOG_UPDATE_EXTERNAL_DATA_SOURCE`

Tool to update an existing external data source in PostHog (e.g., Stripe, Salesforce). Use when you need to modify the description, credentials, or configuration of an external data source. Requires both project_id and the data source UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this external data source |
| `account_id` | string | Yes | Account ID for the external data source (e.g., Stripe account ID) |
| `job_inputs` | object | No | Additional job input parameters for the data source |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the external data source (max 400 characters) |
| `client_secret` | string | Yes | Client secret or API key for authenticating with the external data source |
| `revenue_analytics_config` | object | No | Revenue analytics configuration for the data source |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update feature flag configuration

**Slug:** `POSTHOG_UPDATE_FEATURE_FLAG`

Manage feature flags for your app with creation, reading, updating, and deletion options. Utilize PostHog's JS library or endpoint for flag status. More info in docs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this feature flag. |
| `key` | string | Yes | Key |
| `name` | string | No | contains the description for the flag (field name `name` is kept for backwards-compatibility)  |
| `tags` | array | No | Tags |
| `active` | boolean | No | Active |
| `deleted` | boolean | No | Deleted |
| `filters` | object | No | Filters |
| `surveys` | object | No | Surveys |
| `can_edit` | boolean | No | Can Edit |
| `features` | object | No | Features |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `experiment_set` | array | No | Experiment Set |
| `is_simple_flag` | boolean | No | Is Simple Flag |
| `usage_dashboard` | integer | No | Usage Dashboard |
| `performed_rollback` | boolean | No | Performed Rollback |
| `rollout_percentage` | integer | No | Rollout Percentage |
| `rollback_conditions` | string | No | Rollback Conditions |
| `analytics_dashboards` | array | No | Analytics Dashboards |
| `has_enriched_analytics` | boolean | No | Has Enriched Analytics |
| `ensure_experience_continuity` | boolean | No | Ensure Experience Continuity |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update file system

**Slug:** `POSTHOG_UPDATE_FILE_SYSTEM`

Tool to update a file system resource in PostHog by UUID and project ID. Use when you need to modify details of an existing file system resource such as path, type, depth, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this file system. |
| `ref` | string | No | Reference identifier for the file system (max 100 characters) |
| `href` | string | No | URL reference to the file system resource |
| `meta` | object | No | Additional metadata associated with the file system resource |
| `path` | string | Yes | Path of the file system resource |
| `type` | string | No | Type of the file system resource (max 100 characters) |
| `depth` | integer | No | Depth level of the file system resource in the hierarchy |
| `shortcut` | boolean | No | Whether this file system resource is a shortcut |
| `created_at` | string | Yes | ISO 8601 timestamp of when the file system was created |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `last_viewed_at` | string | No | ISO 8601 timestamp of when the file system was last viewed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update group type metric

**Slug:** `POSTHOG_UPDATE_GROUPS_TYPES_METRIC`

Tool to update a specific group usage metric by its ID. Use when you need to modify the configuration, filters, display format, name, or calculation interval for a particular metric within a group type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this group usage metric |
| `name` | string | Yes | Name of the group usage metric |
| `format` | string ("numeric" | "currency") | No | Format options for group metrics |
| `display` | string ("number" | "sparkline") | No | Display format options for group metrics |
| `filters` | object | Yes | Filter configuration for the group usage metric |
| `interval` | integer | No | Interval in days for the metric calculation |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `group_type_index` | integer | Yes | Numerical identifier for the group type (e.g., 0, 1, 2). Used to differentiate between different types of groups such as companies, projects, or teams. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update hog function

**Slug:** `POSTHOG_UPDATE_HOG_FUNCTION`

Tool to update a hog function by UUID and project ID using PUT method. Use when you need to modify a hog function with full replacement semantics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this hog function. |
| `hog` | string | No | Hog code for the function |
| `name` | string | No | Name of the hog function (max 400 characters) |
| `type` | string | No | Type of the hog function |
| `inputs` | object | No | Input values for the hog function with bytecode, order, templating, transpiled, and value properties |
| `deleted` | boolean | No | Whether the hog function is marked as deleted (soft delete) |
| `enabled` | boolean | No | Whether the hog function is enabled |
| `filters` | object | No | Filter configuration for the hog function including actions, events, properties, and source |
| `masking` | object | No | Masking configuration with hash, ttl, bytecode, and threshold properties |
| `icon_url` | string | No | URL of the icon for the hog function |
| `mappings` | array | No | Mappings configuration for the hog function with filters, inputs, inputs_schema, and name properties |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `description` | string | No | Description of the hog function |
| `template_id` | string | No | Template ID (max 400 characters) |
| `inputs_schema` | array | No | Schema defining the inputs for the hog function with key and type as required fields |
| `batch_export_id` | string | No | UUID of the associated batch export |
| `execution_order` | integer | No | Execution order of the hog function (0-32767) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Insight Variable

**Slug:** `POSTHOG_UPDATE_INSIGHT_VARIABLE`

Update an insight variable by replacing all its properties. Use when you need to completely update all fields of an existing insight variable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this insight variable. |
| `name` | string | Yes | Name of the insight variable (max 400 characters) |
| `type` | string ("String" | "Number" | "Boolean" | "List" | "Date") | Yes | Type of the insight variable (String, Number, Boolean, List, or Date) |
| `values` | string | No | Possible values for the insight variable (for List type variables) |
| `code_name` | string | Yes | Code name for the insight variable, used for programmatic access |
| `created_at` | string | No | ISO 8601 timestamp when the insight variable was created |
| `created_by` | integer | No | ID of the user who created the insight variable |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `default_value` | string | No | Default value for the insight variable. Type depends on the 'type' field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update live debugger breakpoint

**Slug:** `POSTHOG_UPDATE_LIVE_DEBUGGER_BREAKPOINT`

Tool to update a live debugger breakpoint for a project. Use when you need to modify breakpoint configuration such as filename, line number, enabled status, or condition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this live debugger breakpoint |
| `enabled` | boolean | No | Whether the breakpoint is enabled. If true, the breakpoint will be active |
| `filename` | string | Yes | The filename where the breakpoint is set |
| `condition` | string | No | Optional condition expression for the breakpoint. The breakpoint will only trigger when this condition evaluates to true |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |
| `repository` | string | No | Optional repository identifier where the file is located |
| `line_number` | integer | Yes | The line number where the breakpoint is set. Must be non-negative |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization details by uuid

**Slug:** `POSTHOG_UPDATE_ORGANIZATION`

Update specific details of an organization using its UUID. Allows PATCH requests with JSON, form data, or multipart. Requires `organization:write` permission. Returns updated organization info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `slug` | string | No | Slug |
| `teams` | array | No | Teams |
| `metadata` | string | No | Metadata |
| `created_at` | string | No | Created At |
| `updated_at` | string | No | Updated At |
| `customer_id` | string | No | Customer Id |
| `enforce_2fa` | boolean | No | Enforce 2Fa |
| `member_count` | string | No | Member Count |
| `available_product_features` | array | No | Available Product Features |
| `is_member_join_email_enabled` | boolean | No | Is Member Join Email Enabled |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization batch export

**Slug:** `POSTHOG_UPDATE_ORGANIZATION_BATCH_EXPORT`

Tool to update an existing organization-level batch export configuration in PostHog. Use when you need to modify batch export settings like name, schedule, destination, or filtering options at the organization level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to update |
| `name` | string | Yes | A human-readable name for this batch export |
| `model` | string | No | Which model this batch export is exporting (events, persons, or sessions) |
| `end_at` | string | No | Time after which batch export runs won't be triggered (ISO 8601 datetime) |
| `paused` | boolean | No | Whether this batch export is paused or not |
| `schema` | object | No | Schema of custom fields to select when exporting data |
| `filters` | object | No | Additional filters to apply to the exported data |
| `interval` | string ("hour" | "day" | "week" | "every 5 minutes") | Yes | How frequently the batch export runs (hour, day, week, or every 5 minutes) |
| `start_at` | string | No | Time before which batch export runs won't be triggered (ISO 8601 datetime) |
| `timezone` | string | No | Timezone for scheduling the batch export |
| `offset_day` | integer | No | Day offset for weekly exports (0=Sunday, 6=Saturday) |
| `destination` | object | Yes | The destination configuration where data will be exported |
| `hogql_query` | string | No | Custom HogQL query for filtering exported data |
| `offset_hour` | integer | No | Hour offset for daily exports (0-23) |
| `organization_id` | string | Yes | The UUID of the organization containing the batch export |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Modify org info via uuid

**Slug:** `POSTHOG_UPDATE_ORGANIZATION_BY_UUID`

PUT /api/organizations/{id}/: Update organization details by providing a UUID as 'id'. Supports JSON, form-urlencoded, multipart/form-data. Requires 'organization:write' permission. Returns updated organization data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this organization. |
| `name` | string | Yes | Name of the organization (required). |
| `slug` | string | No | Slug |
| `enforce_2fa` | boolean | No | Enforce 2Fa |
| `is_member_join_email_enabled` | boolean | No | Is Member Join Email Enabled |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization domain info and saml config

**Slug:** `POSTHOG_UPDATE_ORGANIZATION_DOMAIN`

Update an organization's authentication domain settings, including SAML SSO configuration and user provisioning policies. This action allows you to modify: - Domain name for authentication - Just-in-time (JIT) user provisioning settings - SSO enforcement policies - SAML identity provider configuration (Entity ID, ACS URL, X.509 certificate) Prerequisites: - The domain must be verified (DNS TXT record validation on PostHog Cloud) - SAML features require a PostHog Enterprise plan - User must have admin permissions for the organization Use cases: - Configure SAML SSO for enterprise authentication - Enable automatic user provisioning for verified domains - Enforce SSO login for specific email domains - Update SAML IdP certificates during rotation

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the domain to update. |
| `domain` | string | Yes | The domain name (e.g., 'example.com') to be used for authentication. Must be a verified domain. |
| `saml_acs_url` | string | No | The SAML Assertion Consumer Service (ACS) URL from your SAML identity provider. This is the URL where SAML assertions are sent after successful authentication. |
| `saml_entity_id` | string | No | The SAML Entity ID (also known as Issuer) from your SAML identity provider. This uniquely identifies your SAML IdP. |
| `saml_x509_cert` | string | No | The X.509 certificate from your SAML identity provider, used to verify SAML assertions. Provide the certificate in PEM format. |
| `organization_id` | string | Yes | The UUID of the organization that owns this domain. |
| `sso_enforcement` | string | No | SSO enforcement policy for this domain. When set, users with email addresses on this domain will be required to use the specified SSO provider. Common values include SAML provider identifiers or authentication method names. |
| `jit_provisioning_enabled` | boolean | No | Enable just-in-time (JIT) user provisioning. When true, new user accounts are automatically created when a user logs in via SSO with an email matching this verified domain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization member by uuids

**Slug:** `POSTHOG_UPDATE_ORGANIZATION_MEMBER`

Update an organization member's access level and permissions. Use this to promote members to admin/owner or demote them to basic member access. Supports partial updates - only send the fields you want to change (typically just 'level'). Returns the complete updated membership record including user details, access level, authentication status, and timestamps. Requires organization_member:write permission. Common use cases: promoting a member to admin (level=8), granting owner access (level=15), or downgrading permissions (level=1). Note: You cannot modify your own membership level as a security restriction - use a different owner/admin to change your permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `level` | integer | No | Membership access level to set for this user. Valid values: 1 (member with basic access), 8 (admin with elevated permissions), 15 (owner with full control). Use this to promote/demote members. |
| `user__uuid` | string | Yes | UUID of the user whose organization membership you want to update. You can get this by listing organization members. |
| `organization_id` | string | Yes | UUID of the organization containing the member to update. You can get this from the current user profile or by listing organizations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization member details

**Slug:** `POSTHOG_UPDATE_ORGANIZATION_MEMBER_COMPLETE`

Update member details in an organization by ID and user UUID. Requires org member write permission. Accepts JSON, form, or multipart. Responses reflect member info, including roles and security settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `joined_at` | string | Yes | Joined At |
| `updated_at` | string | Yes | Updated At |
| `user__uuid` | string | Yes | User Uuid |
| `is_2fa_enabled` | boolean | Yes | Is 2Fa Enabled |
| `has_social_auth` | boolean | Yes | Has Social Auth |
| `organization_id` | string | Yes | Organization Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization proxy record

**Slug:** `POSTHOG_UPDATE_ORGANIZATION_PROXY_RECORD`

Update an organization's proxy record configuration. Proxy records enable custom domain routing for PostHog analytics to bypass ad blockers. **WARNING**: This endpoint may have server-side issues and return 500 errors. The PostHog API for updating proxy records appears to have stability issues. Consider creating a new proxy record instead if updates fail. **Typical Use Cases**: - Update proxy record metadata or messages - Modify domain configuration (requires DNS reconfiguration) **Important Notes**: - Most proxy record fields (target_cname, status, timestamps) are managed by PostHog and should not be manually updated - Changing the domain requires updating your DNS CNAME records accordingly - Requires organization write access (organization:write permission) **Authentication**: Requires a valid API token with organization write permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The UUID of the proxy record to update. Example: '019c0f36-94ac-0000-0fa9-137ee5d79c7e' |
| `domain` | string | No | The custom domain name for the proxy record (e.g., 'analytics.yourdomain.com'). NOTE: Changing the domain may require DNS reconfiguration. |
| `status` | string | No | The status of the proxy record. Possible values: 'waiting' (awaiting DNS verification), 'issuing' (SSL certificate being provisioned), 'live' (fully operational). This field is typically managed by PostHog and should not be manually updated. |
| `message` | string | No | Additional status message or error information about the proxy record. |
| `created_at` | string | No | ISO 8601 timestamp when the proxy record was created (read-only). |
| `created_by` | integer | No | User ID of the person who created the proxy record (read-only). |
| `updated_at` | string | No | ISO 8601 timestamp when the proxy record was last updated (read-only). |
| `target_cname` | string | No | The PostHog CNAME target (read-only, managed by PostHog). This field typically should not be updated manually. |
| `organization_id` | string | Yes | The UUID of the organization that owns the proxy record. Example: '019c0f24-2413-0000-bbbc-d276c57e0dbb' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update role details in organization

**Slug:** `POSTHOG_UPDATE_ORGANIZATION_ROLE`

Update an organization role by submitting its UUID and organization_id in UUID format. Role details must be in JSON or form-data. Only users with 'organization:write' can do this. Returns updated role data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this role. |
| `name` | string | Yes | Name of the role to update |
| `organization_id` | string | Yes | Organization Id |
| `feature_flags_access_level` | integer | No | Feature flags access level for the role |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update persisted folder

**Slug:** `POSTHOG_UPDATE_PERSISTED_FOLDER`

Tool to update an existing persisted folder in PostHog. Use when you need to modify folder properties like path, protocol, or type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the Persisted Folder to update |
| `path` | string | No | File system path for the persisted folder |
| `type` | string ("home" | "pinned" | "custom_products") | Yes | Type of the persisted folder (home, pinned, or custom_products) |
| `protocol` | string | No | Protocol prefix for the folder (max 64 characters) |
| `created_at` | string | Yes | ISO 8601 timestamp when the folder was created |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `updated_at` | string | Yes | ISO 8601 timestamp when the folder was last updated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update person properties

**Slug:** `POSTHOG_UPDATE_PERSON_PROPERTIES`

Request data's "properties" will be updated on a person using "$set" event, affecting only listed properties without deletion or other changes. For property removal, use 'delete_property' endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `uuid` | string | No | Uuid |
| `format` | string ("csv" | "json") | No | Format |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `properties` | string | No | Properties |
| `distinct_ids` | array | No | Distinct Ids |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update person property endpoint

**Slug:** `POSTHOG_UPDATE_PERSON_PROPERTY`

This endpoint allows for reading and deleting individuals. Use the capture API, `$set` and `$unset` properties, or SDKs for creating or updating persons.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A unique UUID value identifying this person. |
| `key` | string | Yes | Specify the property key |
| `value` | string | Yes | Specify the property value |
| `format` | string ("csv" | "json") | No | Format |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update product tour

**Slug:** `POSTHOG_UPDATE_PRODUCT_TOUR`

Update an existing product tour in PostHog. Use this to modify tour name, description, targeting, content, and scheduling. Requires project_id and product tour id (UUID).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this product tour. |
| `name` | string | Yes | Name of the product tour (maximum 400 characters). |
| `content` | object | No | Content configuration for the product tour. |
| `archived` | boolean | No | Whether the product tour is archived. |
| `end_date` | string | No | End date for the product tour in ISO 8601 format. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/. |
| `start_date` | string | No | Start date for the product tour in ISO 8601 format. |
| `auto_launch` | boolean | No | Whether the product tour should auto-launch. |
| `description` | string | No | Description of the product tour. |
| `targeting_flag_filters` | object | No | Targeting flag filters for the product tour, excluding base exclusion properties. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project action by id

**Slug:** `POSTHOG_UPDATE_PROJECT_ACTION`

PUT endpoint '/api/projects/{project_id}/actions/{id}/' updates actions in a project by ID, accepts JSON/form data, supports 'format' query, and needs 'action:write' authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this action. |
| `name` | string | No | Name |
| `tags` | array | No | Tags |
| `steps` | array | No | Steps |
| `format` | string ("csv" | "json") | No | Format |
| `deleted` | boolean | No | Deleted |
| `team_id` | integer | No | Team Id |
| `is_action` | boolean | No | Is Action |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `post_to_slack` | boolean | No | Post To Slack |
| `bytecode_error` | string | No | Bytecode Error |
| `is_calculating` | boolean | No | Is Calculating |
| `last_calculated_at` | string | No | Last Calculated At |
| `slack_message_format` | string | No | Slack Message Format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project batch export

**Slug:** `POSTHOG_UPDATE_PROJECT_BATCH_EXPORT`

Tool to update a batch export configuration within a project using PUT method. Use when you need to modify batch export settings like name, destination, interval, or pause status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying the batch export to update |
| `name` | string | Yes | A human-readable name for this batch export |
| `model` | string ("events" | "persons" | "sessions") | No | Batch export model types |
| `end_at` | string | No | ISO 8601 timestamp - time after which batch export runs won't be triggered |
| `paused` | boolean | Yes | Whether this batch export is paused or not |
| `schema` | object | No | A schema of custom fields to select when exporting data |
| `filters` | object | No | Filter configuration to specify which data to export |
| `interval` | string ("hour" | "day" | "week" | "every 5 minutes") | Yes | Export frequency/interval for the batch export (hour, day, week, or every 5 minutes) |
| `start_at` | string | No | ISO 8601 timestamp - time before which batch export runs won't be triggered |
| `timezone` | string | No | Timezone for scheduling the batch export (e.g., UTC, America/New_York) |
| `offset_day` | integer | No | Day offset for weekly exports (0=Sunday through 6=Saturday) |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/ |
| `destination` | object | Yes | Destination configuration for where data is exported |
| `hogql_query` | string | No | HogQL query string for filtering or transforming exported data |
| `offset_hour` | integer | No | Hour offset for daily exports (0-23) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project cohort details

**Slug:** `POSTHOG_UPDATE_PROJECT_COHORT`

Update cohort details of a specific project by ID. Requires project and cohort ID in the path and a JSON, form-encoded, or multipart form body. Permissions: cohort:write. Returns updated cohort data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this cohort. |
| `name` | string | No | Name |
| `query` | string | No | Query |
| `groups` | string | No | Groups |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `is_static` | boolean | No | Is Static |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project dashboard details

**Slug:** `POSTHOG_UPDATE_PROJECT_DASHBOARD`

Endpoint to update an existing dashboard within a project. Provide `project_id` and `dashboard_id` in path, send JSON or form data with dashboard details. Requires `dashboard:write` permission; responds with updated dashboard data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this dashboard. |
| `name` | string | No | Name |
| `tags` | array | No | Tags |
| `tiles` | array | No | Tiles |
| `pinned` | boolean | No | Pinned |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `is_shared` | boolean | No | Is Shared |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `use_template` | string | No | Use Template |
| `use_dashboard` | integer | No | Use Dashboard |
| `delete_insights` | boolean | No | Delete Insights |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project early access feature

**Slug:** `POSTHOG_UPDATE_PROJECT_EARLY_ACCESS_FEATURE`

Update a specific early access feature of a project by providing the `project_id` and feature `id` (UUID). Requires a JSON body with feature details and responds with the updated status. Authentication via PersonalAPIKeyAuth is mandatory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this early access feature. |
| `name` | string | Yes | Name |
| `stage` | string ("draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived") | No | * `draft` - draft * `concept` - concept * `alpha` - alpha * `beta` - beta * `general-availability` - general availability * `archived` - archived  |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `documentation_url` | string | No | Documentation Url |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project event definition

**Slug:** `POSTHOG_UPDATE_PROJECT_EVENT_DEFINITION`

Update an existing event definition for a specified project using its UUID. Requires a project ID and event definition write permissions. Responds without a body on success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this event definition. |
| `name` | string | No | The name of the event definition. |
| `tags` | array | No | Tags associated with this event definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `post_to_slack` | boolean | No | Whether to post this event to Slack. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project group type metadata

**Slug:** `POSTHOG_UPDATE_PROJECT_GROUP_TYPE`

PATCH /api/projects/{project_id}/groups_types/update_metadata: Update group type metadata for a specific project using its project_id. Can modify name_singular and name_plural fields up to 400 characters each.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_type` | string | No | Group Type |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `name_plural` | string | No | Name Plural |
| `name_singular` | string | No | Name Singular |
| `group_type_index` | integer | No | Group Type Index |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project insight details

**Slug:** `POSTHOG_UPDATE_PROJECT_INSIGHT`

Endpoint "/api/projects/{project_id}/insights/{id}/" allows for updating an insight's details for a given project and insight ID, supporting JSON and CSV formats, with fields like name, query, and various timestamps. Requires insight write permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id |
| `name` | string | No | Name |
| `tags` | array | No | Tags |
| `hogql` | string | No | Hogql |
| `order` | integer | No | Order |
| `query` | string | No | Query node JSON string |
| `saved` | boolean | No | Saved |
| `types` | string | No | Types |
| `format` | string ("csv" | "json") | No | Format |
| `result` | string | No | Result |
| `columns` | string | No | Columns |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `short_id` | string | No | Short Id |
| `timezone` | string | No | The timezone this chart is displayed in. |
| `favorited` | boolean | No | Favorited |
| `is_cached` | string | No | Is Cached |
| `is_sample` | boolean | No | Is Sample |
| `created_at` | string | No | Created At |
| `dashboards` | array | No |          DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.         A dashboard ID for each of the dashboards that this insight is displayed on.           |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `updated_at` | string | No | Updated At |
| `description` | string | No | Description |
| `derived_name` | string | No | Derived Name |
| `last_refresh` | string | No |      The datetime this insight"s results were generated.     If added to one or more dashboards the insight can be refreshed separately on each.     Returns the appropriate last_refresh datetime for the context the insight is viewed in     (see from_dashboard query parameter).       |
| `query_status` | string | No | Query Status |
| `dashboard_tiles` | array | No |      A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.       |
| `cache_target_age` | string | No | The target age of the cached results for this insight. |
| `last_modified_at` | string | No | Last Modified At |
| `next_allowed_client_refresh` | string | No |      The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed     by querying the database.       |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project member s role by uuid

**Slug:** `POSTHOG_UPDATE_PROJECT_MEMBER`

Update explicit project membership using UUIDs. This PUT endpoint modifies a project member's role, where '1' stands for member and '8' for administrator. Requires `project_id` and `parent_membership__user__uuid`. Note: This endpoint only works for projects with access control enabled (private projects). If the project does not have access control enabled, the API will return a 404 "Endpoint not found" error. Access control is an Enterprise feature that can be enabled in Project Settings > Access Control.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `level` | integer | No | The access level for the member. Common values: 1 (member), 8 (admin). |
| `project_id` | string | Yes | Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint only works for projects with access control enabled (private projects). |
| `effective_level` | integer | No | The effective access level for the member (read-only, computed from multiple sources). |
| `parent__membership__user__uuid` | string | Yes | The UUID of the user whose membership is being updated (from organization membership). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project notebook details

**Slug:** `POSTHOG_UPDATE_PROJECT_NOTEBOOK`

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Title |
| `content` | string | No | Content |
| `deleted` | boolean | No | Deleted |
| `version` | integer | No | Version |
| `short_id` | string | Yes | Short Id of the notebook |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `text_content` | string | No | Text Content |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project property definition

**Slug:** `POSTHOG_UPDATE_PROJECT_PROPERTY_DEFINITION`

Update a property definition in a project by its UUID. Requires a project_id and definition id, both as path parameters. Security: PersonalAPIKeyAuth with write access. No body in the response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this property definition. |
| `name` | string | Yes | The name of the property definition. |
| `tags` | array | No | List of tags associated with the property definition. |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `property_type` | string | No | The type of property. Possible values include: 'Boolean', 'Numeric', 'String', 'DateTime'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project session recording playlist

**Slug:** `POSTHOG_UPDATE_PROJECT_SESSION_RECORDING_PLAYLIST`

Update an existing session recording playlist for a project with the specified project_id and playlist short_id. Requires JSON or form data input to modify the playlist's properties like name, description, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Id |
| `name` | string | No | Name |
| `pinned` | boolean | No | Pinned |
| `deleted` | boolean | No | Deleted |
| `filters` | string | No | Filters |
| `short_id` | string | Yes | Short Id |
| `created_at` | string | Yes | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `description` | string | No | Description |
| `derived_name` | string | No | Derived Name |
| `last_modified_at` | string | Yes | Last Modified At |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project settings

**Slug:** `POSTHOG_UPDATE_PROJECT_SETTINGS`

Tool to update project settings and configuration within a PostHog organization. Use when you need to modify project properties such as timezone, feature toggles, or recording settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique value identifying this project. This is the project ID (integer) not UUID. |
| `name` | string | No | Project name. |
| `app_urls` | array | No | List of application URLs for this project. |
| `timezone` | string | No | Project timezone (e.g., 'UTC', 'America/New_York'). |
| `anonymize_ips` | boolean | No | Whether to anonymize IP addresses in data collection. |
| `surveys_opt_in` | boolean | No | Whether surveys are enabled. |
| `heatmaps_opt_in` | boolean | No | Whether heatmaps are enabled. |
| `inject_web_apps` | boolean | No | Whether to inject web apps. |
| `organization_id` | string | Yes | Organization UUID or ID containing the project. |
| `primary_dashboard` | integer | No | Primary dashboard ID for this project. |
| `recording_domains` | array | No | List of domains for session recording. |
| `autocapture_opt_out` | boolean | No | Whether autocapture is disabled for this project. |
| `product_description` | string | No | Product description (max 1000 characters). |
| `slack_incoming_webhook` | string | No | Slack incoming webhook URL for notifications. |
| `session_recording_opt_in` | boolean | No | Whether session recording is enabled. |
| `capture_console_log_opt_in` | boolean | No | Whether console log capture is enabled. |
| `capture_performance_opt_in` | boolean | No | Whether performance capture is enabled. |
| `completed_snippet_onboarding` | boolean | No | Whether snippet onboarding has been completed. |
| `autocapture_exceptions_opt_in` | boolean | No | Whether exception autocapture is enabled. |
| `autocapture_web_vitals_opt_in` | boolean | No | Whether web vitals autocapture is enabled. |
| `session_recording_sample_rate` | string | No | Session recording sample rate (e.g., '1.0' for 100%). |
| `person_display_name_properties` | array | No | List of person properties to use for display names. |
| `test_account_filters_default_checked` | boolean | No | Whether test account filters are checked by default. |
| `session_recording_minimum_duration_milliseconds` | integer | No | Minimum session duration in milliseconds to record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project subscription details

**Slug:** `POSTHOG_UPDATE_PROJECT_SUBSCRIPTION`

Update a subscription for a specific project. Provide project_id and subscription id in the path and use MIME types like application/json with fields like frequency, target_type, etc. Requires `subscription:write` permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this subscription. |
| `count` | integer | No | Count |
| `title` | string | No | Title |
| `deleted` | boolean | No | Deleted |
| `insight` | integer | No | Insight |
| `bysetpos` | integer | No | Bysetpos |
| `interval` | integer | No | Interval |
| `byweekday` | array | No | Byweekday |
| `dashboard` | integer | No | Dashboard |
| `frequency` | string ("daily" | "weekly" | "monthly" | "yearly") | Yes | * `daily` - Daily * `weekly` - Weekly * `monthly` - Monthly * `yearly` - Yearly  |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | Yes | Start Date |
| `until_date` | string | No | Until Date |
| `target_type` | string ("email" | "slack" | "webhook") | Yes | * `email` - Email * `slack` - Slack * `webhook` - Webhook |
| `target_value` | string | Yes | Target Value |
| `invite_message` | string | No | Invite Message |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project survey details

**Slug:** `POSTHOG_UPDATE_PROJECT_SURVEY`

The `/api/projects/{project_id}/surveys/{id}/` PUT endpoint updates survey details in a project using survey UUID and project ID, accepts JSON/form/multipart data, needs `survey:write` permission, and returns the updated survey.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this survey. |
| `name` | string | Yes | Name |
| `type` | string ("popover" | "widget" | "button" | "email" | "full_screen" | "api") | Yes | * `popover` - popover * `widget` - widget * `button` - button * `email` - email * `full_screen` - full screen * `api` - api  |
| `archived` | boolean | No | Archived |
| `end_date` | string | No | End Date |
| `questions` | string | No |          The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice.         Basic (open-ended question)         - `type`: `open`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `branching`: Branching logic for the question. See branching types below for details.         Link (a question with a link)         - `type`: `link`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `link`: The URL associated with the question.         - `branching`: Branching logic for the question. See branching types below for details.         Rating (a question with a rating scale)         - `type`: `rating`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `display`: Display style of the rating (`number` or `emoji`).         - `scale`: The scale of the rating (`number`).         - `lowerBoundLabel`: Label for the lower bound of the scale.         - `upperBoundLabel`: Label for the upper bound of the scale.         - `branching`: Branching logic for the question. See branching types below for details.         Multiple choice         - `type`: `single_choice` or `multiple_choice`         - `question`: The text of the question.         - `description`: Optional description of the question.         - `descriptionContentType`: Content type of the description (`html` or `text`).         - `optional`: Whether the question is optional (`boolean`).         - `buttonText`: Text displayed on the submit button.         - `choices`: An array of choices for the question.         - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`).         - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`).         - `branching`: Branching logic for the question. See branching types below for details.         Branching logic can be one of the following types:         Next question: Proceeds to the next question         ```json         {             "type": "next_question"         }         ```         End: Ends the survey, optionally displaying a confirmation message.         ```json         {             "type": "end"         }         ```         Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types.         ```json         {             "type": "response_based",             "responseValues": {                 "responseKey": "value"             }         }         ```         Specific question: Proceeds to a specific question by index.         ```json         {             "type": "specific_question",             "index": 2         }         ```           |
| `appearance` | string | No | Appearance |
| `conditions` | string | No | Conditions |
| `created_at` | string | No | Created At |
| `project_id` | string | Yes | Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.  |
| `start_date` | string | No | Start Date |
| `description` | string | No | Description |
| `linked_flag_id` | integer | No | Linked Flag Id |
| `iteration_count` | integer | No | Iteration Count |
| `responses_limit` | integer | No | Responses Limit |
| `current_iteration` | integer | No | Current Iteration |
| `iteration_start_dates` | array | No | Iteration Start Dates |
| `iteration_frequency_days` | integer | No | Iteration Frequency Days |
| `current_iteration_start_date` | string | No | Current Iteration Start Date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update user home settings

**Slug:** `POSTHOG_UPDATE_USER_HOME_SETTINGS`

Tool to update user home settings including homepage and tab configurations. Use when you need to modify the personalized home page and tab settings for a user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tabs` | array | No | List of tab configurations to update |
| `uuid` | string | Yes | UUID of the user to update home settings for. Use '@me' to update settings for the authenticated user. |
| `homepage` | object | No | Homepage configuration for the user |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update warehouse saved query

**Slug:** `POSTHOG_UPDATE_WAREHOUSE_SAVED_QUERY`

Update a warehouse saved query in PostHog by completely replacing it with new data. Use when you need to update the name, query definition, or edit history of an existing saved query. This performs a complete update (PUT) operation requiring the edited_history_id for tracking changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | A UUID string identifying this data warehouse saved query. |
| `name` | string | Yes | Name for the warehouse saved query. Maximum length is 128 characters. |
| `query` | object | Yes | HogQL query object containing the query kind and query string to execute |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `edited_history_id` | string | Yes | UUID of the edited history record. This tracks the edit lineage of the saved query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update web experiment

**Slug:** `POSTHOG_UPDATE_WEB_EXPERIMENT`

Tool to completely update a web experiment in PostHog using PUT method. Use when you need to replace the entire web experiment configuration with new values. Unlike PATCH, this requires all fields to be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | A unique integer value identifying this web experiment. |
| `name` | string | Yes | Name of the web experiment (max 400 characters) |
| `variants` | object | Yes | Variants configuration for the web experiment. Keys are variant names (e.g., 'control', 'test'), values are variant configurations with transforms and rollout percentages |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| `feature_flag_key` | string | Yes | Feature flag key to associate with this web experiment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate LLM Provider API Key

**Slug:** `POSTHOG_VALIDATE_LLM_PROVIDER_KEY`

Tool to validate LLM provider API keys without persisting them to PostHog. Use when you need to verify if an API key for an LLM provider is valid before saving it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key` | string | Yes | API key to validate for the specified LLM provider |
| `provider` | string | Yes | LLM provider name (e.g., 'openai', 'anthropic', 'google') |
| `project_id` | string | Yes | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get current user (whoami)

**Slug:** `POSTHOG_WHOAMI`

DEPRECATED: Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS instead. Diagnostic tool to validate PostHog credentials and retrieve current user information. Returns the authenticated user's profile along with accessible organizations, teams, and projects. Use this to confirm API key validity and discover team/project IDs for subsequent API calls. When multiple organizations or projects are returned, explicitly select the intended one by ID rather than defaulting to the first result.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |