- Category: analytics
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 690
- Triggers: 11
- Slug:
POSTHOG - Version: 20261101_00
Frequently Asked Questions
How do I set up custom OAuth credentials for PostHog?
How do I set up custom OAuth credentials for PostHog?
How do I configure the PostHog region for US or EU Cloud?
How do I configure the PostHog region for US or EU Cloud?
us for US Cloud or eu for EU Cloud. Do not pass a full URL such as https://eu.posthog.com; the toolkit builds the host as <region>.posthog.com from the region value.This matters because the PostHog API host is different for US and EU Cloud, and region is connection-specific rather than one fixed auth-config value for every connected account. A connection that should call eu.posthog.com but is left on the default us region can fail or return data from the wrong PostHog environment.In the Link flow, the user sees a prefilled Region field while connecting and can choose the correct region. In the Initiate flow, set the region during connected-account creation. Existing connections were migrated to keep their current region, so they do not need to reconnect only because of this field change.Tools
Add dashboard collaborators with access level
Add dashboard collaborators with access level
POSTHOG_ADD_DASHBOARD_COLLABORATORS_WITH_ACCESS_LEVELAdd 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
Output
Create Dashboard Widgets Batch
Create Dashboard Widgets Batch
POSTHOG_ADD_DASHBOARD_WIDGETSBatch dashboard widgets in a PostHog project. Add multiple widget tiles to a dashboard in one atomic request.Input Parameters
Output
Add member to organization role
Add member to organization role
Add persons to static cohort
Add persons to static cohort
POSTHOG_ADD_PERSONS_TO_STATIC_COHORTAdd 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
Output
Add product intent to project
Add product intent to project
POSTHOG_ADD_PRODUCT_INTENT_TO_PROJECTTool 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
Output
Add project specific member roles
Add project specific member roles
POSTHOG_ADD_PROJECT_SPECIFIC_MEMBER_ROLESAdd 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
Output
Add session recording to playlist
Add session recording to playlist
POSTHOG_ADD_SESSION_RECORDING_TO_PLAYLISTAdd 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
Output
Append Desktop Recording Segments
Append Desktop Recording Segments
POSTHOG_APPEND_DESKTOP_RECORDING_SEGMENTSAppend 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
Output
Archive Dataset
Archive Dataset
Archive Dataset Item
Archive Dataset Item
Archive Experiment
Archive Experiment
POSTHOG_ARCHIVE_EXPERIMENTArchive experiment in a PostHog project. Archive an ended experiment.Input Parameters
Output
Archive Feature Flag
Archive Feature Flag
Archive Llm Prompt
Archive Llm Prompt
Archive survey response
Archive survey response
POSTHOG_ARCHIVE_SURVEY_RESPONSETool 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
Output
Assign feature flag role based access
Assign feature flag role based access
POSTHOG_ASSIGN_FEATURE_FLAG_ROLE_BASED_ACCESSSet 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
Output
Create Notebook Widgets Attach
Create Notebook Widgets Attach
POSTHOG_ATTACH_NOTEBOOK_WIDGETAttach notebook widget in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Bulk create organization invites
Bulk create organization invites
Bulk Delete Dashboards
Bulk Delete Dashboards
POSTHOG_BULK_DELETE_DASHBOARDSBulk delete dashboards in a PostHog project. Soft-delete up to 100 dashboards. Optionally delete insights with no remaining dashboard. Report missing or inaccessible dashboards as skipped.Input Parameters
Output
Bulk delete feature flags
Bulk delete feature flags
POSTHOG_BULK_DELETE_FEATURE_FLAGSBulk delete feature flags in a PostHog project using either filter criteria or explicit IDs. Returns an operation status and, when available, a deleted count.Input Parameters
Output
Bulk Delete Insights
Bulk Delete Insights
POSTHOG_BULK_DELETE_INSIGHTSBulk delete insights in a PostHog project. Soft-delete insights in bulk by ID. Mirrors the single-insight delete: sets deleted=True, soft-deletes the insights’ dashboard tiles, and removes their linked alerts. Insights the requester cannot edit are skipped and reported in skipped. Reversible via the bulk_restore endpoint.Input Parameters
Output
Create Persons Bulk Delete
Create Persons Bulk Delete
POSTHOG_BULK_DELETE_PERSONSRequest bulk deletion of persons by PostHog person IDs or distinct IDs. Options allow requesting deletion of associated events and recordings or retaining person records; deletion is asynchronous and batched.Input Parameters
Output
Bulk Restore Insights
Bulk Restore Insights
POSTHOG_BULK_RESTORE_INSIGHTSBulk restore insights in a PostHog project. Restore soft-deleted insights in bulk by ID — the inverse of bulk_delete. Sets deleted=False and re-activates the insights’ dashboard tiles on dashboards that still exist. Linked alerts are not restored (they are removed on delete). Insights the requester cannot edit are reported in skipped.Input Parameters
Output
Bulk Set Test Account Filter Insights
Bulk Set Test Account Filter Insights
POSTHOG_BULK_SET_TEST_ACCOUNT_FILTER_INSIGHTSSet test account filter in bulk in a PostHog project. Turn ‘filter out internal and test users’ on or off for every existing insight in the project. Requires project admin, matching the settings UI that fronts it. The setting of the same name only decides the default for new insights; this applies it to the insights that already exist. Only insights that store a query are changed; insights still holding legacy filters are counted in legacy and left as they are. Insights with nowhere to put the toggle, such as SQL insights, are left alone, as are insights the requester cannot edit. Dashboards follow their insights unless the dashboard sets its own override. Insights are updated in batches, so a failure part way through leaves the finished batches applied. Retrying is safe and picks up the rest.Input Parameters
Output
Create Experiment Calculate Running Time
Create Experiment Calculate Running Time
POSTHOG_CALCULATE_EXPERIMENT_RUNNING_TIMECalculate experiment running time in a PostHog project. Estimate the recommended sample size and running time for an experiment.Input Parameters
funnel - funnel * mean_count - mean_count * mean_sum_or_avg - mean_sum_or_avg * ratio - ratio * retention - retentionOutput
Create Notebook Widgets Cancel
Create Notebook Widgets Cancel
Cancel insights for a project
Cancel insights for a project
POSTHOG_CANCEL_PROJECT_INSIGHTSSubmit a request to cancel a running or queued insight query in a PostHog project, typically using its client query ID.Input Parameters
Output
Capture Event
Capture Event
POSTHOG_CAPTURE_EVENTSend a single analytics event to PostHog’s public ingestion endpoint using a project API key. A success response indicates receipt, not guaranteed ingestion.Input Parameters
Output
Create Insight Data Checks
Create Insight Data Checks
POSTHOG_CHECK_INSIGHT_QUERY_DATACheck insight query data quality in a PostHog project. Check the events behind an insight for the common ways they mislead: internal and test users, local development traffic, bots and crawlers, and events sent twice. Works for trends, funnels, stickiness and lifecycle insights whose series are events. The checks apply the insight’s own filters, and read the newest days of its date range, up to 7. The bot and duplicate checks read a sample of those days. For a token, the internal users check matches the emails of the organization’s members only with the organization_member:read scope, and its verified domains only with organization:read. It names the emails it finds only with person:read. Nothing is stored. This route runs the query it is sent, so it needs query access as well as insight access. To check a saved insight by its id, send a GET request to insights/{id}/data_checks/.Input Parameters
quick, the default, reads within a small budget so the checks can run on every load. On an insight they would read a lot of data for, a quick check does not run and status is on_request. full runs the checks with the same limits as the insight’s own query. * quick - Read within a small budget, so the checks can run on every load * full - Read with the same limits as the insight’s own queryInsightVizNode with its source. Pass the query of a saved insight, or one that is not saved yet.query/{client_query_id}/.Output
Check pipeline destination updates
Check pipeline destination updates
POSTHOG_CHECK_PIPELINE_DESTINATION_UPDATESCheck 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
Output
Check pipeline import app updates
Check pipeline import app updates
POSTHOG_CHECK_PIPELINE_IMPORT_APP_UPDATESRetrieve 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
Output
Check pipeline plugin update status
Check pipeline plugin update status
POSTHOG_CHECK_PIPELINE_PLUGIN_UPDATE_STATUSGet 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
Output
Check project's demo data generation status
Check project's demo data generation status
POSTHOG_CHECK_PROJECT_DEMO_DATA_GENERATION_STATUSCheck 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
Output
Create Notebook Kernel Complete
Create Notebook Kernel Complete
POSTHOG_COMPLETE_NOTEBOOK_CODEComplete notebook code in a PostHog project. Completions for the cursor position in a Python cell, from the notebook’s running kernel. Returns no matches when no kernel is running or the kernel is busy, and never starts one. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Notebook Kernel Config
Create Notebook Kernel Config
POSTHOG_CONFIGURE_NOTEBOOK_KERNELConfigure notebook kernel in a PostHog project. Set the notebook’s kernel compute configuration. Applies at sandbox provision time: a currently running kernel keeps its resources until restarted. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Dashboard Copy Tile
Create Dashboard Copy Tile
Create Experiment Copy To Project
Create Experiment Copy To Project
POSTHOG_COPY_EXPERIMENT_TO_PROJECTCopy experiment to project in a PostHog project. Copy an experiment into another project in the same organization as a new draft.Input Parameters
Output
Create Account Notebook
Create Account Notebook
POSTHOG_CREATE_ACCOUNT_NOTEBOOKCreate account notebook in a PostHog project.Input Parameters
Output
Create Max AI insight and query
Create Max AI insight and query
POSTHOG_CREATE_AI_INSIGHTTool 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
Output
Create alert
Create alert
POSTHOG_CREATE_ALERTCreate a PostHog alert configuration for an insight with thresholds and notification settings. The alert can notify subscribed users when threshold conditions are met.Input Parameters
Output
Create Batch
Create Batch
POSTHOG_CREATE_BATCHCapture 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
Output
Create batch export
Create batch export
POSTHOG_CREATE_BATCH_EXPORTCreate 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
Output
Create batch exports backfills
Create batch exports backfills
POSTHOG_CREATE_BATCH_EXPORT_BACKFILLTool 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
Output
Create batch exports run test step
Create batch exports run test step
POSTHOG_CREATE_BATCH_EXPORT_TEST_RUNTool 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
Output
Create customer profile config
Create customer profile config
POSTHOG_CREATE_CUSTOMER_PROFILE_CONFIGCreate 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
Output
Create project insights with customizable parameters
Create project insights with customizable parameters
POSTHOG_CREATE_CUSTOM_PROJECT_INSIGHTSCreate custom analytics insights for a PostHog project. Supported query types (InsightVizNode.source.kind): TrendsQuery, FunnelsQuery, RetentionQuery, PathsQuery, StickinessQuery, LifecycleQuery, WebStatsTableQuery, WebOverviewQuery. IMPORTANT: HogQLQuery is NOT supported for saved insights. For ad-hoc HogQL queries, use POSTHOG_CREATE_QUERY_IN_PROJECT_BY_ID instead. Key parameters: - project_id (required): Project ID - query: InsightVizNode with source containing one of the 8 valid query types above - name: Display name - saved: Whether to save permanently (default: true) - tags: Organization tags - format: ‘json’ or ‘csv’ Returns the created insight with id, short_id, timestamps, and configured properties.Input Parameters
Output
Create Dashboard Sharing Passwords
Create Dashboard Sharing Passwords
POSTHOG_CREATE_DASHBOARD_SHARING_PASSWORDCreate a dashboard sharing password and return its plaintext value once. Requires password protection to already be enabled on the dashboard sharing configuration and the organization’s Access Control feature. Does not enable sharing or password protection.Input Parameters
Output
Create Dashboard Text Tile
Create Dashboard Text Tile
POSTHOG_CREATE_DASHBOARD_TEXT_TILEAdd a Markdown text or image tile to a dashboard in a PostHog project.Input Parameters
text - text * image - imageOutput
Create data color theme
Create data color theme
POSTHOG_CREATE_DATA_COLOR_THEMETool 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
Output
Create Dataset
Create Dataset
POSTHOG_CREATE_DATASETTool 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
Output
Create Dataset Exports
Create Dataset Exports
Create Dataset Items
Create Dataset Items
POSTHOG_CREATE_DATASET_ITEMTool 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
Output
Create Dataset Item Restore
Create Dataset Item Restore
Create Dataset Restore
Create Dataset Restore
Create desktop recording
Create desktop recording
POSTHOG_CREATE_DESKTOP_RECORDINGCreate 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
Output
Create endpoint
Create endpoint
POSTHOG_CREATE_ENDPOINTTool 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
Output
Create error tracking autocapture controls
Create error tracking autocapture controls
POSTHOG_CREATE_ERROR_TRACKING_AUTOCAPTURE_CONTROLTool 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
Output
Create Error Tracking Query Issue
Create Error Tracking Query Issue
POSTHOG_CREATE_ERROR_TRACKING_QUERY_ISSUEGet compact issue details in a PostHog project. Fetch one error tracking issue with impact counts, trend, top in_app frame, first and latest release, and optional sparkline and event breakdown.Input Parameters
Output
Create Error Tracking Query Issue Events
Create Error Tracking Query Issue Events
POSTHOG_CREATE_ERROR_TRACKING_QUERY_ISSUE_EVENTSList sampled exception events in a PostHog project. Fetch sampled exception events, stack traces, browser/SDK context, URL, and $session_id values for one issue.Input Parameters
Output
Create Error Tracking Query Issues
Create Error Tracking Query Issues
POSTHOG_CREATE_ERROR_TRACKING_QUERY_ISSUESList compact issues in a PostHog project. List error tracking issues with typed filters and compact aggregate counts.Input Parameters
archived - archived * active - active * resolved - resolved * pending_release - pending_release * suppressed - suppressed * all - alllast_seen - last_seen * first_seen - first_seen * occurrences - occurrences * users - users * sessions - sessions * severity - severityOutput
Create error tracking release
Create error tracking release
POSTHOG_CREATE_ERROR_TRACKING_RELEASECreate 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
Output
Create error tracking suppression rule
Create error tracking suppression rule
POSTHOG_CREATE_ERROR_TRACKING_SUPPRESSION_RULETool 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
Output
Create Evaluation
Create Evaluation
POSTHOG_CREATE_EVALUATIONCreate 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
Output
Create evaluation run
Create evaluation run
POSTHOG_CREATE_EVALUATION_RUNCreate an evaluation run for a specific existing PostHog event for asynchronous execution. The response may include a workflow ID and status.Input Parameters
Output
Create event definitions
Create event definitions
POSTHOG_CREATE_EVENT_DEFINITIONCreate 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
Output
Create experiment exposure cohort
Create experiment exposure cohort
Create Experiment From Prompt
Create Experiment From Prompt
POSTHOG_CREATE_EXPERIMENT_FROM_PROMPTCreate a draft experiment comparing 2-10 distinct existing versions of one LLM prompt. Creates a NEW feature flag with control/test variants, equal traffic splits and JSON prompt-version payloads, plus primary metrics for distinct cost, latency or eval_pass_rate templates. Does not launch the experiment. Prompt versions must exist and be unarchived; an explicit flag key must not already exist.Input Parameters
Output
Create experiment holdout
Create experiment holdout
POSTHOG_CREATE_EXPERIMENT_HOLDOUTTool 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
Output
Create experiment saved metric
Create experiment saved metric
POSTHOG_CREATE_EXPERIMENT_SAVED_METRICTool 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
Output
Create Feature Flag
Create Feature Flag
POSTHOG_CREATE_FEATURE_FLAGTool 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
Output
Create static cohort for feature flag
Create static cohort for feature flag
Create feature flag dashboard
Create feature flag dashboard
Create file system
Create file system
POSTHOG_CREATE_FILE_SYSTEMTool 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
Output
Create file system shortcut
Create file system shortcut
POSTHOG_CREATE_FILE_SYSTEM_SHORTCUTCreate 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
Output
Create Group
Create Group
POSTHOG_CREATE_GROUPCreate a group with a unique key in an existing PostHog group type. Discover group types before creating a group. Returns the group’s key, type, properties and creation timestamp. An existing key is rejected by PostHog; this is not an upsert. PostHog exposes no individual-group delete endpoint.Input Parameters
Output
Create groups types metrics
Create groups types metrics
POSTHOG_CREATE_GROUP_TYPE_METRICTool 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
Output
Create hog function
Create hog function
POSTHOG_CREATE_HOG_FUNCTIONCreate 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
Output
Create Insight Sharing Passwords
Create Insight Sharing Passwords
POSTHOG_CREATE_INSIGHT_SHARING_PASSWORDCreate a insight sharing password and return its plaintext value once. Requires password protection to already be enabled on the insight sharing configuration and the organization’s Access Control feature. Does not enable sharing or password protection.Input Parameters
Output
Create insight variable
Create insight variable
POSTHOG_CREATE_INSIGHT_VARIABLECreate 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
Output
Create live debugger breakpoint
Create live debugger breakpoint
POSTHOG_CREATE_LIVE_DEBUGGER_BREAKPOINTTool 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
Output
Create LLM Analytics Summarization
Create LLM Analytics Summarization
POSTHOG_CREATE_LLM_ANALYTICS_SUMMARIZATIONGenerate 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
Output
Create LLM Analytics Text Representation
Create LLM Analytics Text Representation
POSTHOG_CREATE_LLM_ANALYTICS_TEXT_REPRESENTATIONTool 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
Output
Create LLM Prompt
Create LLM Prompt
POSTHOG_CREATE_LLM_PROMPTCreate a named, versioned LLM prompt in a PostHog project. Use to store a new prompt with optional model or agent configuration. To publish another version of an existing prompt, use the prompt publishing endpoint instead.Input Parameters
Output
Create Logs Export
Create Logs Export
POSTHOG_CREATE_LOGS_EXPORTTool 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
Output
Create Notebook Sharing Passwords
Create Notebook Sharing Passwords
POSTHOG_CREATE_NOTEBOOK_SHARING_PASSWORDCreate a notebook sharing password and return its plaintext value once. Requires password protection to already be enabled on the notebook sharing configuration and the organization’s Access Control feature. Does not enable sharing or password protection.Input Parameters
Output
Create Notebook Widget Snapshots
Create Notebook Widget Snapshots
POSTHOG_CREATE_NOTEBOOK_WIDGET_SNAPSHOTSCreate widget snapshot in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Notebook Widget Snapshots Publish
Create Notebook Widget Snapshots Publish
POSTHOG_CREATE_NOTEBOOK_WIDGET_SNAPSHOTS_PUBLISHPublish widget snapshot in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create new organization with configurable access
Create new organization with configurable access
POSTHOG_CREATE_ORGANIZATIONCreate 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
Output
Create organization invite with role and email
Create organization invite with role and email
POSTHOG_CREATE_ORGANIZATION_INVITECreate 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
Output
Create organization proxy record for custom domain
Create organization proxy record for custom domain
POSTHOG_CREATE_ORGANIZATION_PROXY_RECORDCreate 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
Output
Create organization role with feature flag levels
Create organization role with feature flag levels
POSTHOG_CREATE_ORGANIZATION_ROLECreate 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
Output
Create domain with saml for organization
Create domain with saml for organization
POSTHOG_CREATE_ORGANIZATION_SAML_DOMAINCreate 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
Output
Create persisted folder
Create persisted folder
POSTHOG_CREATE_PERSISTED_FOLDERTool 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
Output
Create person path with format option
Create person path with format option
POSTHOG_CREATE_PERSON_PATHRetrieve 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
Output
Create product tour
Create product tour
POSTHOG_CREATE_PRODUCT_TOURTool 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
Output
Create project action with format
Create project action with format
POSTHOG_CREATE_PROJECT_ACTIONCreate an action in a PostHog project using action details such as its name, description, tags, and steps. An optional format parameter selects CSV or JSON output.Input Parameters
Output
Create project cohorts
Create project cohorts
POSTHOG_CREATE_PROJECT_COHORTCreate 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
Output
Create project dashboard
Create project dashboard
POSTHOG_CREATE_PROJECT_DASHBOARDThe 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
Output
Create new project experiment
Create new project experiment
POSTHOG_CREATE_PROJECT_EXPERIMENTCreate a new experiment in a specific PostHog project using experiment details and a personal API key. Returns experiment information.Input Parameters
Output
Create project insights with format option
Create project insights with format option
POSTHOG_CREATE_PROJECT_INSIGHTS_WITH_FORMAT_OPTIONCreate 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
Output
Create a notebook in a project
Create a notebook in a project
POSTHOG_CREATE_PROJECT_NOTEBOOKCreate a notebook in a PostHog project. The feature is in early access and its API can have breaking changes without announcement.Input Parameters
Output
Create project pipeline frontend app job
Create project pipeline frontend app job
POSTHOG_CREATE_PROJECT_PIPELINE_FRONTEND_APP_JOBCreate 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
Output
Create Retrieve Retention Insights For Project
Create Retrieve Retention Insights For Project
POSTHOG_CREATE_PROJECT_RETENTION_INSIGHTCreate 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
Output
Create project subscription with delivery options
Create project subscription with delivery options
POSTHOG_CREATE_PROJECT_SUBSCRIPTIONCreate 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
daily- Daily *weekly- Weekly *monthly- Monthly *yearly- Yearly
Output
Create project surveys with questions and targets
Create project surveys with questions and targets
POSTHOG_CREATE_PROJECT_SURVEYCreate a project survey with a name, type, and optional questions and targeting settings. Uses personal API key authentication and returns a survey object on success.Input Parameters
popover- popover *widget- widget *button- button *email- email *full_screen- full screen *api- api
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 } Output
Create query in project by id
Create query in project by id
POSTHOG_CREATE_QUERY_IN_PROJECT_BY_IDSubmit a query for a specific project using structured query details. Supports asynchronous execution and returns query results or execution status.Input Parameters
id of the query can be used to check the status and to cancel it.Output
Create session recording playlists
Create session recording playlists
POSTHOG_CREATE_SESSION_RECORDING_PLAYLISTCreate 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
Output
Generate AI summary for session recording
Generate AI summary for session recording
POSTHOG_CREATE_SESSION_RECORDING_SUMMARYGenerate 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
Output
Create Surveys Summary Headline
Create Surveys Summary Headline
POSTHOG_CREATE_SURVEY_SUMMARY_HEADLINETool 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
Output
Create warehouse saved query
Create warehouse saved query
POSTHOG_CREATE_WAREHOUSE_SAVED_QUERYCreate 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
Output
Create Web Experiment
Create Web Experiment
POSTHOG_CREATE_WEB_EXPERIMENTCreate 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
Output
Delete Account Notebook
Delete Account Notebook
Delete alert
Delete alert
POSTHOG_DELETE_ALERTDelete 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
Output
Delete Customer Profile Config
Delete Customer Profile Config
POSTHOG_DELETE_CUSTOMER_PROFILE_CONFIGDelete a customer profile configuration by ID in a PostHog project. Returns a success flag and confirmation message after a successful response.Input Parameters
Output
Delete Dashboard Sharing Passwords
Delete Dashboard Sharing Passwords
Create Dashboard Delete Tile
Create Dashboard Delete Tile
Delete desktop recording
Delete desktop recording
POSTHOG_DELETE_DESKTOP_RECORDINGTool 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
Output
Delete endpoint
Delete endpoint
POSTHOG_DELETE_ENDPOINTDelete 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
Output
Delete error tracking autocapture controls
Delete error tracking autocapture controls
POSTHOG_DELETE_ERROR_TRACKING_AUTOCAPTURE_CONTROLDelete an error tracking autocapture control configuration by UUID and project ID. Use when you need to remove autocapture settings for error tracking.Input Parameters
Output
Delete error tracking grouping rule
Delete error tracking grouping rule
POSTHOG_DELETE_ERROR_TRACKING_GROUPING_RULEDelete 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
Output
Delete error tracking release
Delete error tracking release
POSTHOG_DELETE_ERROR_TRACKING_RELEASEDelete an error tracking release by its UUID and project ID, requiring the ‘error_tracking:write’ scope. Returns a status code and a success flag that is true for HTTP 204.Input Parameters
Output
Delete Error Tracking Suppression Rule
Delete Error Tracking Suppression Rule
POSTHOG_DELETE_ERROR_TRACKING_SUPPRESSION_RULETool 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
Output
Delete experiment holdout
Delete experiment holdout
POSTHOG_DELETE_EXPERIMENT_HOLDOUTDelete 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
Output
Delete experiment saved metric
Delete experiment saved metric
Remove feature flag role access by id
Remove feature flag role access by id
POSTHOG_DELETE_FEATURE_FLAG_ROLE_ACCESSDELETE /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
Output
Delete file system
Delete file system
POSTHOG_DELETE_FILE_SYSTEMTool 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
Output
Create Group Delete Property
Create Group Delete Property
Delete Groups Types Metrics
Delete Groups Types Metrics
POSTHOG_DELETE_GROUP_TYPE_METRICTool 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
Output
Delete insight
Delete insight
POSTHOG_DELETE_INSIGHTAttempt to delete an insight by ID from a PostHog project. A 405 response is reported as not supported; a 204 response is reported as successful.Input Parameters
Output
Delete Insight Sharing Passwords
Delete Insight Sharing Passwords
Delete insight variables
Delete insight variables
POSTHOG_DELETE_INSIGHT_VARIABLEDelete 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
Output
Delete live debugger breakpoint
Delete live debugger breakpoint
POSTHOG_DELETE_LIVE_DEBUGGER_BREAKPOINTDelete 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
Output
Delete Llm Prompt Labels
Delete Llm Prompt Labels
Delete Notebook Sharing Passwords
Delete Notebook Sharing Passwords
POSTHOG_DELETE_NOTEBOOK_SHARING_PASSWORDDelete notebook sharing password in a PostHog project. Delete a password from the sharing configuration. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Delete organization by uuid
Delete organization by uuid
Remove organization batch export by uuid
Remove organization batch export by uuid
Remove domain by uuid from organization
Remove domain by uuid from organization
Remove member from organization by uuid
Remove member from organization by uuid
POSTHOG_DELETE_ORGANIZATION_MEMBERRemove a member from a PostHog organization using the user’s UUID, rather than the membership ID. A member who is not found is treated as successfully removed. Requires organization_member:write permission; you cannot remove yourself with this action.Input Parameters
Output
Remove organization pipeline destination
Remove organization pipeline destination
Remove org pipeline import app by id
Remove org pipeline import app by id
Remove organization pipeline transformation
Remove organization pipeline transformation
Remove organization plugin by id
Remove organization plugin by id
Delete organization project
Delete organization project
Remove organization proxy record
Remove organization proxy record
Remove organization role by id
Remove organization role by id
Delete persisted folder
Delete persisted folder
POSTHOG_DELETE_PERSISTED_FOLDERDelete 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
Output
Delete person and optionally associated events
Delete person and optionally associated events
POSTHOG_DELETE_PERSONDelete a person by UUID in a PostHog project, optionally requesting deletion of their associated events.Input Parameters
Output
Delete person property
Delete person property
POSTHOG_DELETE_PERSON_PROPERTYDelete 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
Output
Delete product tours
Delete product tours
POSTHOG_DELETE_PRODUCT_TOURDelete 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
Output
Remove specific project batch export
Remove specific project batch export
POSTHOG_DELETE_PROJECT_BATCH_EXPORTDelete 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
Output
Remove project dashboard collaborator
Remove project dashboard collaborator
POSTHOG_DELETE_PROJECT_DASHBOARD_COLLABORATORRemove 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
Output
Remove early access feature from project
Remove early access feature from project
POSTHOG_DELETE_PROJECT_EARLY_ACCESS_FEATUREDelete 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
Output
Remove project event definition
Remove project event definition
POSTHOG_DELETE_PROJECT_EVENT_DEFINITIONDelete 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
Output
Remove project experiment by id
Remove project experiment by id
POSTHOG_DELETE_PROJECT_EXPERIMENTUpdate the deleted flag of an experiment by its integer ID within a project, using a personal API key with experiment write permission. The flag defaults to true for soft deletion and can be set to false.Input Parameters
Output
Remove explicit project member by uuid
Remove explicit project member by uuid
POSTHOG_DELETE_PROJECT_MEMBERDelete 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
Output
Remove project plugin configuration
Remove project plugin configuration
POSTHOG_DELETE_PROJECT_PLUGIN_CONFIGURATIONDELETE /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
Output
Remove specific project query
Remove specific project query
Remove property definition by uuid
Remove property definition by uuid
POSTHOG_DELETE_PROPERTY_DEFINITIONDelete 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
Output
Remove rolemembership by uuid
Remove rolemembership by uuid
POSTHOG_DELETE_ROLE_MEMBERSHIPRemove 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
Output
Delete session recording by uuid
Delete session recording by uuid
POSTHOG_DELETE_SESSION_RECORDINGDelete 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
Output
Remove session recording from playlist
Remove session recording from playlist
POSTHOG_DELETE_SESSION_RECORDING_FROM_PLAYLISTRemove 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
Output
Delete survey by id
Delete survey by id
POSTHOG_DELETE_SURVEYDelete 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
Output
Delete warehouse saved query
Delete warehouse saved query
POSTHOG_DELETE_WAREHOUSE_SAVED_QUERYTool 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
Output
Delete web experiment
Delete web experiment
POSTHOG_DELETE_WEB_EXPERIMENTDelete 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
Output
Disable Feature Flag
Disable Feature Flag
POSTHOG_DISABLE_FEATURE_FLAGDisable feature flag in a PostHog project. Disable a feature flag.Input Parameters
version from your most recent read of this flag. Required when the flag’s filters.version is 2, optional otherwise. When sent, the change is refused with 409 if anyone else changed the flag after that version. Null is the same as leaving it out.Output
Cohort duplication to static
Cohort duplication to static
POSTHOG_DUPLICATE_COHORT_TO_STATICThis 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
Output
Duplicate experiment
Duplicate experiment
POSTHOG_DUPLICATE_EXPERIMENTTool 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
Output
Duplicate Llm Prompt
Duplicate Llm Prompt
POSTHOG_DUPLICATE_LLM_PROMPTDuplicate named LLM prompt in a PostHog project.Input Parameters
Output
Duplicate survey to projects
Duplicate survey to projects
POSTHOG_DUPLICATE_SURVEY_TO_PROJECTSDuplicate 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
Output
Enable Feature Flag
Enable Feature Flag
POSTHOG_ENABLE_FEATURE_FLAGEnable feature flag in a PostHog project. Enable a feature flag.Input Parameters
version from your most recent read of this flag. Required when the flag’s filters.version is 2, optional otherwise. When sent, the change is refused with 409 if anyone else changed the flag after that version. Null is the same as leaving it out.Output
Enable project early access feature
Enable project early access feature
POSTHOG_ENABLE_PROJECT_EARLY_ACCESS_FEATUREEnables a new early access feature for a project using project ID, payload with details, and PersonalAPIKeyAuth. Returns a 201 status on success.Input Parameters
draft- draft *concept- concept *alpha- alpha *beta- beta *general-availability- general availability *archived- archived
Output
End Experiment
End Experiment
POSTHOG_END_EXPERIMENTEnd experiment in a PostHog project. End a running experiment without shipping a variant.Input Parameters
won - won * lost - lost * inconclusive - inconclusive * stopped_early - stopped_early * invalid - invalidorganization/repository format. Only used when open_cleanup_pr is true. It must be one of the team’s connected repositories (see the flag_cleanup_target action); it is then saved as the experiment’s repository. When omitted, the experiment’s saved repository, the team’s default cleanup repository, or the team’s only connected repository is used.repository as this environment’s default cleanup repository, used for experiments that have no repository of their own. Only acts when open_cleanup_pr is true and repository is provided and belongs to the team’s GitHub installation. Requires project admin access (403 otherwise).Output
Finish symbol sets bulk upload
Finish symbol sets bulk upload
POSTHOG_FINISH_SYMBOL_SETS_BULK_UPLOADTool 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
Output
Flag annotation as deleted
Flag annotation as deleted
POSTHOG_FLAG_ANNOTATION_AS_DELETEDUpdate an annotation’s deleted flag by project and annotation ID. The flag defaults to true to mark the annotation as deleted, but can also be set to false.Input Parameters
Output
Create Notebook Widgets Fork
Create Notebook Widgets Fork
Create Experiment Freeze Exposure
Create Experiment Freeze Exposure
Create Insight Generate Metadata
Create Insight Generate Metadata
POSTHOG_GENERATE_INSIGHT_METADATAGenerate insight metadata in a PostHog project. Generate an AI-suggested name and description for an insight based on its query configuration.Input Parameters
include_dashboards=true is passed. Once opt-in enforcement is enabled, API-token callers (personal API keys, OAuth) must opt in the same way. Do not rely on it being present.Output
Generate Insight Name
Generate Insight Name
POSTHOG_GENERATE_INSIGHT_NAMETool 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
Output
Create Notebook Widgets Generate
Create Notebook Widgets Generate
POSTHOG_GENERATE_NOTEBOOK_WIDGETQueue AI generation for an existing markdown Widget node in a PostHog notebook. Returns HTTP 202 status, not completed source. Requires organization AI data-processing approval and available AI credits; generation may incur charges. Reuse generation_id only for identical retries. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
claude-haiku-4-5 - claude-haiku-4-5 * claude-sonnet-4-6 - claude-sonnet-4-6 * claude-sonnet-5 - claude-sonnet-5 * claude-opus-5 - claude-opus-5initial - initial * regenerate - regenerate * improve - improveOutput
Generate project funnel correlation insight
Generate project funnel correlation insight
POSTHOG_GENERATE_PROJECT_FUNNEL_CORRELATION_INSIGHTThe /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
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.event (default): a property key - person: a person property key - cohort: an array of cohort IDs (ie [9581,5812])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.0 means user, >0 means a group. See interface for the corresponding ID of the group.Output
Create Survey Generate Translations
Create Survey Generate Translations
POSTHOG_GENERATE_SURVEY_TRANSLATIONSGenerate survey translations in a PostHog project.Input Parameters
base_language (or ‘en’ if unset).Output
Accounts Notebooks Get
Accounts Notebooks Get
Get Action References
Get Action References
Retrieve app metrics by ids
Retrieve app metrics by ids
POSTHOG_GET_APP_METRICSRetrieve 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
Output
Retrieve app metrics error details
Retrieve app metrics error details
POSTHOG_GET_APP_METRICS_ERROR_DETAILSRetrieve detailed error information for a plugin configuration in a PostHog project, to investigate failures experienced by the app or plugin.Input Parameters
Output
Retrieve batch export details
Retrieve batch export details
POSTHOG_GET_BATCH_EXPORT_DETAILSRetrieve 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
Output
Get batch exports backfills
Get batch exports backfills
POSTHOG_GET_BATCH_EXPORTS_BACKFILLSTool 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
Output
Get billing details
Get billing details
Retrieve cohort activity details
Retrieve cohort activity details
Get Cohort Blocking Workflows
Get Cohort Blocking Workflows
POSTHOG_GET_COHORT_BLOCKING_WORKFLOWSFind blocking workflows in a PostHog project. Active workflows that block deleting this cohort or editing it so it stops updating in real time.Input Parameters
Output
Retrieve cohort person details
Retrieve cohort person details
POSTHOG_GET_COHORT_PERSON_DETAILSRetrieve 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
Output
Get cohort calculation history
Get cohort calculation history
POSTHOG_GET_COHORTS_CALCULATION_HISTORYTool 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
Output
Get Cohort Used In
Get Cohort Used In
Get conversation
Get conversation
POSTHOG_GET_CONVERSATIONTool 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
Output
Get conversations
Get conversations
POSTHOG_GET_CONVERSATIONSTool 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
Output
Get current personal API key
Get current personal API key
Get Customer Profile Config
Get Customer Profile Config
POSTHOG_GET_CUSTOMER_PROFILE_CONFIGRetrieve 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
Output
Get customer profile configs
Get customer profile configs
POSTHOG_GET_CUSTOMER_PROFILE_CONFIGSTool 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
Output
Get Dashboard Run Insights
Get Dashboard Run Insights
POSTHOG_GET_DASHBOARD_RUN_INSIGHTSRun dashboard insights in a PostHog project and return their results. You can select specific insight tiles or run the dashboard’s insight tiles.Input Parameters
date_from, date_to, properties). Ignored when accessed via a sharing token.code_name — partial entries are silently dropped. The simplest workflow is to call dashboard-get first, copy the matching entry from the response, and mutate value. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a sharing token.Output
Get Dashboard Run Widgets
Get Dashboard Run Widgets
Retrieve dashboard template details by uuid
Retrieve dashboard template details by uuid
POSTHOG_GET_DASHBOARD_TEMPLATE_DETAILSFetch 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
Output
Retrieve dashboard template schema
Retrieve dashboard template schema
POSTHOG_GET_DASHBOARD_TEMPLATE_SCHEMARetrieve 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
Output
Get data color theme
Get data color theme
POSTHOG_GET_DATA_COLOR_THEMETool 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
Output
Get Data Color Themes
Get Data Color Themes
POSTHOG_GET_DATA_COLOR_THEMESTool 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
Output
Get dataset details
Get dataset details
POSTHOG_GET_DATASETRetrieve detailed information about a specific dataset within a project. Use this to get dataset properties including name, description, creator info, and timestamps.Input Parameters
Output
Get Dataset Exports
Get Dataset Exports
POSTHOG_GET_DATASET_EXPORTSRetrieve dataset export in a PostHog project. Check the status of a dataset export created by the current user.Input Parameters
Output
Get Dataset Exports Content
Get Dataset Exports Content
POSTHOG_GET_DATASET_EXPORTS_CONTENTDownload dataset export in a PostHog project. Download a completed dataset JSONL export.Input Parameters
Output
Get Dataset Item
Get Dataset Item
POSTHOG_GET_DATASET_ITEMTool 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
Output
Get dataset items
Get dataset items
POSTHOG_GET_DATASET_ITEMSTool 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
Output
Get Dataset Item Versions
Get Dataset Item Versions
POSTHOG_GET_DATASET_ITEM_VERSIONSList dataset item versions in a PostHog project. List every immutable version of an item, newest first. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
Output
Get Dataset Revisions
Get Dataset Revisions
POSTHOG_GET_DATASET_REVISIONSList dataset revisions in a PostHog project. List immutable dataset revisions, newest first. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
Output
Get Datasets
Get Datasets
POSTHOG_GET_DATASETSTool 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
Output
Get desktop recordings
Get desktop recordings
POSTHOG_GET_DESKTOP_RECORDINGSTool 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
Output
Get Endpoint
Get Endpoint
Create Endpoint Last Execution Times
Create Endpoint Last Execution Times
POSTHOG_GET_ENDPOINT_LAST_EXECUTION_TIMESRetrieve last execution times in a PostHog project. Get the most recent execution time per endpoint (endpoint-level). Timestamps are recorded by the run path for personal-API-key calls. For per-version usage, query the query_log table directly.Input Parameters
Output
Get Endpoint Logs
Get Endpoint Logs
POSTHOG_GET_ENDPOINT_LOGSRetrieve endpoint logs in a PostHog project, with optional time, execution instance, level, search and limit filters. Returns the provider response in data.Input Parameters
Output
Get Endpoint Materialization Status
Get Endpoint Materialization Status
POSTHOG_GET_ENDPOINT_MATERIALIZATION_STATUSGet materialization status in a PostHog project. Get materialization status for an endpoint. Supports ?version=N query param.Input Parameters
Output
Get Endpoint OpenAPI Specification
Get Endpoint OpenAPI Specification
POSTHOG_GET_ENDPOINT_OPENAPI_SPECIFICATIONGet 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
Output
Get Endpoint Run
Get Endpoint Run
Get error tracking assignment rules
Get error tracking assignment rules
POSTHOG_GET_ERROR_TRACKING_ASSIGNMENT_RULESTool 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
Output
Get error tracking autocapture control
Get error tracking autocapture control
POSTHOG_GET_ERROR_TRACKING_AUTOCAPTURE_CONTROLRetrieve 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
Output
Get error tracking fingerprints
Get error tracking fingerprints
POSTHOG_GET_ERROR_TRACKING_FINGERPRINTSTool 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
Output
Get error tracking grouping rules
Get error tracking grouping rules
POSTHOG_GET_ERROR_TRACKING_GROUPING_RULESTool 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
Output
Get error tracking issue
Get error tracking issue
Get error tracking release
Get error tracking release
POSTHOG_GET_ERROR_TRACKING_RELEASERetrieve 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
Output
Get error tracking release by hash
Get error tracking release by hash
POSTHOG_GET_ERROR_TRACKING_RELEASE_BY_HASHTool 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
Output
Get error tracking releases
Get error tracking releases
POSTHOG_GET_ERROR_TRACKING_RELEASESTool 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
Output
Get error tracking suppression rules
Get error tracking suppression rules
POSTHOG_GET_ERROR_TRACKING_SUPPRESSION_RULESTool 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
Output
Get error tracking symbol sets
Get error tracking symbol sets
POSTHOG_GET_ERROR_TRACKING_SYMBOL_SETSRetrieve a paginated list of error tracking symbol sets for a PostHog project, including references, release versions, and any failure reason.Input Parameters
Output
Get Evaluation
Get Evaluation
POSTHOG_GET_EVALUATIONRetrieve 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
Output
Get evaluations for project
Get evaluations for project
POSTHOG_GET_EVALUATIONSTool 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
Output
Retrieve event definition by uuid
Retrieve event definition by uuid
POSTHOG_GET_EVENT_DEFINITIONRetrieve 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
Output
Get event definition by name
Get event definition by name
POSTHOG_GET_EVENT_DEFINITION_BY_NAMELook up an event definition by name within a PostHog project. Returns the event name, elements, and properties from the response.Input Parameters
Output
Retrieve event definitions by project id
Retrieve event definitions by project id
POSTHOG_GET_EVENT_DEFINITIONSRetrieve a page of event definitions for a specified project. Requires Personal API key access with event_definition:read privileges.Input Parameters
Output
Get event definitions in Golang format
Get event definitions in Golang format
POSTHOG_GET_EVENT_DEFINITIONS_GOLANGTool 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
Output
Get event definitions in Python format
Get event definitions in Python format
POSTHOG_GET_EVENT_DEFINITIONS_PYTHONTool 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
Output
Get event definitions TypeScript
Get event definitions TypeScript
POSTHOG_GET_EVENT_DEFINITIONS_TYPESCRIPTTool to retrieve TypeScript event definitions for a specific project. Use when you need to generate type-safe event definitions for TypeScript applications.Input Parameters
Output
Get Experiment Activity
Get Experiment Activity
POSTHOG_GET_EXPERIMENT_ACTIVITYRetrieve experiment activity in a PostHog project. Change history for this experiment. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
Output
Retrieve experiment details by ids
Retrieve experiment details by ids
POSTHOG_GET_EXPERIMENT_DETAILSAccess 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
Output
Get Experiment Flag Cleanup Target
Get Experiment Flag Cleanup Target
POSTHOG_GET_EXPERIMENT_FLAG_CLEANUP_TARGETRetrieve flag cleanup target in a PostHog project. Repository a flag-cleanup pull request for this experiment would be opened in.Input Parameters
Output
Get Experiment Flag Cleanup Task
Get Experiment Flag Cleanup Task
Get Experiment Health
Get Experiment Health
POSTHOG_GET_EXPERIMENT_HEALTHRetrieve experiment health in a PostHog project. Health check findings for this experiment: problems in its configuration and its feature flag that keep it from producing trustworthy results, each with a fix. checks gives the result of each check, so a check that found no problem can be told from one that did not apply or could not read an input.Input Parameters
Output
Get Experiment Health Inputs
Get Experiment Health Inputs
POSTHOG_GET_EXPERIMENT_HEALTH_INPUTSRetrieve experiment health inputs in a PostHog project. Staff only. The inputs that the health checks read for this reader, to debug why a finding shows or not: the context of the checks in health, the exposure query’s answer that the exposure checks read, and facts about the project from the setup context’s providers (the team’s experiment defaults and which SDKs call flags). The exposure answer comes from the cache. When it is missing or stale, a calculation starts in the background and exposures.status says so.Input Parameters
Output
Get experiment holdout details
Get experiment holdout details
POSTHOG_GET_EXPERIMENT_HOLDOUT_DETAILSRetrieve 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
Output
Get experiment holdouts
Get experiment holdouts
POSTHOG_GET_EXPERIMENT_HOLDOUTSTool 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
Output
Get Experiment In Session Exposure
Get Experiment In Session Exposure
POSTHOG_GET_EXPERIMENT_IN_SESSION_EXPOSURERetrieve in-session exposure in a PostHog project. How the recordings tab’s in-session exposure scope reads on this experiment.Input Parameters
Output
Get Experiment Metrics Recalculation
Get Experiment Metrics Recalculation
POSTHOG_GET_EXPERIMENT_METRICS_RECALCULATIONRetrieve metric recalculation in a PostHog project.Input Parameters
Output
Get Experiment Metrics Recalculation Latest
Get Experiment Metrics Recalculation Latest
Get experiment saved metric
Get experiment saved metric
POSTHOG_GET_EXPERIMENT_SAVED_METRICTool 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
Output
Get eligible feature flags for experiments
Get eligible feature flags for experiments
POSTHOG_GET_EXPERIMENTS_ELIGIBLE_FEATURE_FLAGSTool 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
Output
Create Experiment Session Contexts
Create Experiment Session Contexts
POSTHOG_GET_EXPERIMENT_SESSION_CONTEXTSCreate session contexts in a PostHog project. Resolve experiment context for a batch of session recordings.Input Parameters
Output
Create Experiment Session Event Deltas
Create Experiment Session Event Deltas
POSTHOG_GET_EXPERIMENT_SESSION_EVENT_DELTASCalculate session event deltas in a PostHog project. The recordings worth watching for this experiment, grouped into cards.Input Parameters
Output
Create Experiment Setup Context
Create Experiment Setup Context
POSTHOG_GET_EXPERIMENT_SETUP_CONTEXTCreate experiment setup context in a PostHog project. Facts about this project that decide how to configure a new experiment.Input Parameters
Output
Retrieve experiments requiring flag implementation
Retrieve experiments requiring flag implementation
POSTHOG_GET_EXPERIMENTS_REQUIRING_FLAG_IMPLEMENTATIONRetrieve 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
Output
Get experiments stats
Get experiments stats
POSTHOG_GET_EXPERIMENTS_STATSRetrieve experimentation velocity statistics for a PostHog project, including recent launch counts, percentage change, active experiments, and recent completions.Input Parameters
Output
Retrieve export unsubscribe configs
Retrieve export unsubscribe configs
POSTHOG_GET_EXPORT_UNSUBSCRIBE_CONFIGSRetrieves 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
Output
Fetch export unsubscribe settings
Fetch export unsubscribe settings
POSTHOG_GET_EXPORT_UNSUBSCRIBE_SETTINGSRetrieves 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
Output
Get external data schema
Get external data schema
Get external data source
Get external data source
POSTHOG_GET_EXTERNAL_DATA_SOURCETool 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
Output
Get external data sources
Get external data sources
POSTHOG_GET_EXTERNAL_DATA_SOURCESTool 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
Output
Retrieve feature flag activity details
Retrieve feature flag activity details
Retrieve feature flag details
Retrieve feature flag details
POSTHOG_GET_FEATURE_FLAG_DETAILSRetrieve 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
Output
Bulk Keys Feature Flags
Bulk Keys Feature Flags
POSTHOG_GET_FEATURE_FLAG_KEYSRetrieve feature flag keys in bulk in a PostHog project. Get feature flag keys by IDs. Accepts a list of feature flag IDs and returns a mapping of ID to key.Input Parameters
warning field and otherwise ignored.Output
Get Feature Flag Remote Config
Get Feature Flag Remote Config
Retrieve feature flag role access details
Retrieve feature flag role access details
POSTHOG_GET_FEATURE_FLAG_ROLE_ACCESS_DETAILSRetrieve 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
Output
Retrieve feature flags activity log
Retrieve feature flags activity log
Get feature flags dependent flags
Get feature flags dependent flags
POSTHOG_GET_FEATURE_FLAGS_DEPENDENT_FLAGSRetrieve 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
Output
Retrieve feature flags evaluation reasons
Retrieve feature flags evaluation reasons
POSTHOG_GET_FEATURE_FLAGS_EVALUATION_REASONSRetrieve feature flag evaluation results and reasons for a specified user in a PostHog project.Input Parameters
Output
Get feature flags matching IDs
Get feature flags matching IDs
POSTHOG_GET_FEATURE_FLAGS_MATCHING_IDSRetrieve matching feature flag IDs for a PostHog project, limited to flags the user has permission to edit. This action does not accept filter parameters.Input Parameters
Output
Get feature flag status
Get feature flag status
POSTHOG_GET_FEATURE_FLAG_STATUSTool 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
Output
Create Feature Flag User Blast Radius
Create Feature Flag User Blast Radius
Get Feature Flag Versions
Get Feature Flag Versions
Get file system
Get file system
POSTHOG_GET_FILE_SYSTEMTool 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
Output
Get file system shortcut
Get file system shortcut
POSTHOG_GET_FILE_SYSTEM_SHORTCUTRetrieve 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
Output
Retrieve filtered project property definitions
Retrieve filtered project property definitions
POSTHOG_GET_FILTERED_PROJECT_PROPERTY_DEFINITIONSGet 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
event - event * person - person * group - group * session - sessionOutput
Retrieve funnel insights in project
Retrieve funnel insights in project
POSTHOG_GET_FUNNEL_INSIGHTS_IN_PROJECTExecute a funnel analysis for a project using event or action steps. Returns conversion data showing how users progress through the funnel.Input Parameters
Output
Retrieve group property definitions by project id
Retrieve group property definitions by project id
POSTHOG_GET_GROUP_PROPERTY_DEFINITIONSRetrieve a paginated list of group property definitions for a PostHog project, including group type index and other available metadata.Input Parameters
Output
Retrieve group property values by index and key
Retrieve group property values by index and key
Get group type metric by ID
Get group type metric by ID
POSTHOG_GET_GROUPS_TYPES_METRIC_BY_IDTool 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
Output
Get groups types metrics
Get groups types metrics
POSTHOG_GET_GROUPS_TYPES_METRICSTool 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
Output
Retrieve hedgehog configuration by uuid
Retrieve hedgehog configuration by uuid
POSTHOG_GET_HEDGEHOG_CONFIGURATIONRetrieve 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
Output
Retrieve historical app metrics export
Retrieve historical app metrics export
POSTHOG_GET_HISTORICAL_APP_METRICS_EXPORTRetrieve 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
Output
Get hog function
Get hog function
POSTHOG_GET_HOG_FUNCTIONTool 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
Output
Get Hog function metric totals
Get Hog function metric totals
Get hog functions
Get hog functions
POSTHOG_GET_HOG_FUNCTIONSTool 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
Output
Retrieve important project activity log
Retrieve important project activity log
POSTHOG_GET_IMPORTANT_PROJECT_ACTIVITY_LOGRetrieve 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
Output
Get Insight Data Checks
Get Insight Data Checks
POSTHOG_GET_INSIGHT_DATA_CHECKSCheck saved insight data quality in a PostHog project. Run the data checks on a saved insight, found by its numeric id or its short_id. The checks read the query the insight stores, and work the same way as the checks on a query that is not saved. The status is unsupported for an insight that still stores legacy filters and no query. Nothing is stored.Input Parameters
short_id (for example AaVQ8Ijw) identifying the insight.quick, the default, reads within a small budget so the checks can run on every load. On an insight they would read a lot of data for, a quick check does not run and status is on_request. full runs the checks with the same limits as the insight’s own query. * quick - Read within a small budget, so the checks can run on every load * full - Read with the same limits as the insight’s own queryOutput
Retrieve insight sharing configurations
Retrieve insight sharing configurations
POSTHOG_GET_INSIGHT_SHARING_CONFIGURATIONSRetrieve 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
Output
Get insight thresholds
Get insight thresholds
POSTHOG_GET_INSIGHTS_THRESHOLDSTool 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
Output
Get insight threshold
Get insight threshold
POSTHOG_GET_INSIGHT_THRESHOLDTool 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
Output
Get insight variable
Get insight variable
POSTHOG_GET_INSIGHT_VARIABLETool 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
Output
Get insight variables
Get insight variables
POSTHOG_GET_INSIGHT_VARIABLESTool 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
Output
Get live debugger breakpoint
Get live debugger breakpoint
POSTHOG_GET_LIVE_DEBUGGER_BREAKPOINTTool 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
Output
Get live debugger breakpoints
Get live debugger breakpoints
POSTHOG_GET_LIVE_DEBUGGER_BREAKPOINTSTool 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
Output
Get LLM Analytics Evaluation Config
Get LLM Analytics Evaluation Config
POSTHOG_GET_LLM_ANALYTICS_EVALUATION_CONFIGTool 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
Output
Get LLM Analytics Models
Get LLM Analytics Models
POSTHOG_GET_LLM_ANALYTICS_MODELSTool 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
Output
Get LLM Analytics Provider Keys
Get LLM Analytics Provider Keys
POSTHOG_GET_LLM_ANALYTICS_PROVIDER_KEYSTool 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
Output
Get LLM prompt
Get LLM prompt
POSTHOG_GET_LLM_PROMPTRetrieve a PostHog LLM prompt by name, version, or label. Returns the latest version by default, with full content and resolved references. Use preview or none content modes for lightweight prompt metadata.Input Parameters
Output
Get Llm Prompt Resolve
Get Llm Prompt Resolve
POSTHOG_GET_LLM_PROMPT_RESOLVEResolve named LLM prompt in a PostHog project. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
Output
Get Log Alerts Events
Get Log Alerts Events
POSTHOG_GET_LOG_ALERTS_EVENTSList one page of event history for a log alert in a PostHog project, including state transitions, errored checks, and user-initiated control-plane events. Quiet no-op checks are filtered out; checks for alerts evaluated by the alerts platform come from its check history.Input Parameters
Output
Get logs attributes
Get logs attributes
POSTHOG_GET_LOGS_ATTRIBUTESTool 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
Output
Get logs availability status
Get logs availability status
POSTHOG_GET_LOGS_HAS_LOGSTool 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
Output
Get log field values
Get log field values
POSTHOG_GET_LOGS_VALUESTool 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
Output
Get Notebook Collab Stream
Get Notebook Collab Stream
POSTHOG_GET_NOTEBOOK_COLLAB_STREAMRead a bounded batch of notebook collaboration SSE events and return the last event ID for resuming. Stops after the configured time/event limit or five seconds of inactivity, rather than waiting for the stream to close. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Kernel Status
Get Notebook Kernel Status
POSTHOG_GET_NOTEBOOK_KERNEL_STATUSRetrieve notebook kernel status in a PostHog project. Live-checked kernel runtime state for this notebook, its compute configuration, and the catalog of dataframes/tables a cell can currently reference (with column schemas). PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Runs
Get Notebook Runs
POSTHOG_GET_NOTEBOOK_RUNSRetrieve notebook run in a PostHog project. Read a whole-notebook run: its state, which cell it is on, and one line per planned cell. Carries no result rows — fetch a cell’s result from the cell run result endpoint. Flag-gated (revamped-py-notebooks). PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Sharing
Get Notebook Sharing
POSTHOG_GET_NOTEBOOK_SHARINGList notebook sharing settings in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Sql V2 Runs
Get Notebook Sql V2 Runs
POSTHOG_GET_NOTEBOOK_SQL_V2_RUNSRetrieve notebook SQL run in a PostHog project. Read a run’s durable state: its status, and — once done or interrupted — the result envelope (columns, first rows, stdout/stderr, media, error). Poll until terminal. Requires notebook and query read access, including after a notebook feature flag is disabled. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Sql V2 State
Get Notebook Sql V2 State
POSTHOG_GET_NOTEBOOK_SQL_V2_STATERetrieve notebook SQL state in a PostHog project. The full notebook view for agents: title, document source (markdown, or raw content for legacy rich-text notebooks), the notebook’s declared variables, every cell with its dependency edges and derived run status (including staleness), and the kernel’s runtime state and compute config. Flag-gated (revamped-py-notebooks). PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Widgets Frames
Get Notebook Widgets Frames
POSTHOG_GET_NOTEBOOK_WIDGETS_FRAMESRetrieve notebook widget frame in a PostHog project. Returns one page; use the documented pagination parameters for additional pages. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Widget Snapshots
Get Notebook Widget Snapshots
POSTHOG_GET_NOTEBOOK_WIDGET_SNAPSHOTSRetrieve widget snapshot in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Widget Snapshots Frames
Get Notebook Widget Snapshots Frames
POSTHOG_GET_NOTEBOOK_WIDGET_SNAPSHOTS_FRAMESRetrieve widget snapshot frame in a PostHog project. Returns one page; use the documented pagination parameters for additional pages. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Widgets Source
Get Notebook Widgets Source
POSTHOG_GET_NOTEBOOK_WIDGETS_SOURCERetrieve notebook widget source in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Widgets Status
Get Notebook Widgets Status
POSTHOG_GET_NOTEBOOK_WIDGETS_STATUSRetrieve notebook widget status in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Get Notebook Widgets Versions
Get Notebook Widgets Versions
POSTHOG_GET_NOTEBOOK_WIDGETS_VERSIONSList notebook widget versions in a PostHog project. Returns one page; use the documented pagination parameters for additional pages. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Fetch organization details by uuid
Fetch organization details by uuid
Fetch organization pipeline app repositories
Fetch organization pipeline app repositories
POSTHOG_GET_ORGANIZATION_PIPELINE_APP_REPOSITORIESRetrieve 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
Output
Get persisted folders
Get persisted folders
POSTHOG_GET_PERSISTED_FOLDERTool 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
Output
Get Person Emails
Get Person Emails
POSTHOG_GET_PERSON_EMAILSList a page of emails for a person in a PostHog project, with pagination parameters for additional pages.Input Parameters
Output
Get Person Push Notifications
Get Person Push Notifications
POSTHOG_GET_PERSON_PUSH_NOTIFICATIONSList a page of push notifications for a person in a PostHog project, with pagination parameters for additional pages.Input Parameters
Output
Look Up Persons By Distinct IDs
Look Up Persons By Distinct IDs
POSTHOG_GET_PERSONS_BY_DISTINCT_IDSLook up existing persons by distinct IDs in a PostHog project without changing them; only the first 200 IDs are processed, and each person includes at most 10 distinct IDs. JSON returns a map keyed by matched distinct ID; CSV returns raw text in data.Input Parameters
Output
Look Up Persons By UUIDs
Look Up Persons By UUIDs
POSTHOG_GET_PERSONS_BY_UUIDSLook up existing persons by UUIDs without creating or changing them. Returns a map keyed by canonical UUID, omitting unmatched UUIDs. Only the first 200 inputs are processed; each person includes up to 10 distinct IDs. Empty input returns an empty results map. CSV format returns raw text in data.Input Parameters
Output
Fetch pipeline destination activity
Fetch pipeline destination activity
POSTHOG_GET_PIPELINE_DESTINATION_DETAILSRetrieve 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
Output
Fetch pipeline transformation details
Fetch pipeline transformation details
POSTHOG_GET_PIPELINE_TRANSFORMATION_DETAILSRetrieve 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
Output
Get product tour
Get product tour
POSTHOG_GET_PRODUCT_TOURTool 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
Output
Retrieve and delete project person trends
Retrieve and delete project person trends
Fetch project survey activity log
Fetch project survey activity log
POSTHOG_GET_PROJECT_SURVEY_ACTIVITY_LOGRetrieve the survey activity log for a project. Returns activity entries with user, action, item, change details and pagination information; requires personal API key access.Input Parameters
Output
Get Query Scan
Get Query Scan
POSTHOG_GET_QUERY_SCANRetrieve the cached analysis of a query’s last slow run. Use the cache_key from a query response, not a query ID. This read does not execute the query or request analysis. Returns {} while analysis is pending. Returns 404 if no matching analysis exists or PostHog has not enabled scan visibility for the project. A normal fast query may never have a scan. PostHog does not generate new scans for API-key query executions.Input Parameters
Output
Get Role Membership
Get Role Membership
Get session group summaries
Get session group summaries
POSTHOG_GET_SESSION_GROUP_SUMMARIESTool 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
Output
Fetch session recording playlist details
Fetch session recording playlist details
POSTHOG_GET_SESSION_RECORDING_PLAYLIST_DETAILSRetrieve 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
Output
Get Signal Reports Actions
Get Signal Reports Actions
POSTHOG_GET_SIGNAL_REPORTS_ACTIONSList report agent actions in a PostHog project. List the actions on this report that start an agent run, read from the report’s current state. get_it_merged is available only while the report has an open, approved pull request. make_it_green is available only while CI fails on the report’s open pull request. suggested_prompt has one entry per prompt the report suggests. Start one with the run endpoint.Input Parameters
Output
Get spike detection configuration
Get spike detection configuration
Get Survey Responses
Get Survey Responses
POSTHOG_GET_SURVEY_RESPONSESList survey responses in a PostHog project. List survey responses for a specific survey, with question text resolved server-side so callers do not have to map opaque $survey_response_<id> keys. Each row carries distinct_id, session_id, submitted_at, and an extra block (device, browser, OS, geoip, current_url, iteration) so agents can cross-pivot to recordings, persons, or paths in a single follow-up call. For person properties at event time, follow up with persons-get using the returned distinct_id — keeps scopes scoped. Use question_id + score_lte to fetch NPS detractors and similar score-filtered cohorts. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
limit and the has_more field to paginate.question_id is >= this value. Common use: NPS promoters with score_gte=9. Requires question_id.question_id is <= this value. Common use: NPS detractors with score_lte=6. Requires question_id.Output
Get survey response statistics
Get survey response statistics
POSTHOG_GET_SURVEY_RESPONSE_STATISTICSGet 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
Output
Get surveys archived response UUIDs
Get surveys archived response UUIDs
POSTHOG_GET_SURVEYS_ARCHIVED_RESPONSE_UUIDSTool 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
Output
Get surveys stats
Get surveys stats
POSTHOG_GET_SURVEYS_STATSTool 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
Output
Retrieve unused organization pipeline frontend apps
Retrieve unused organization pipeline frontend apps
POSTHOG_GET_UNUSED_ORG_PIPELINE_FRONTEND_APPSRetrieve 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 metadataInput Parameters
Output
Get user home settings
Get user home settings
POSTHOG_GET_USER_HOME_SETTINGSTool 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
Output
Get user interviews
Get user interviews
POSTHOG_GET_USER_INTERVIEWSTool to retrieve paginated list of user interviews for a specific project. Use when you need to access interview recordings, transcripts, and summaries.Input Parameters
Output
Get Vision Alerts Events
Get Vision Alerts Events
POSTHOG_GET_VISION_ALERTS_EVENTSList vision alert events in a PostHog project. Paginated event history for this alert, newest first. Quiet no-op check rows (no state change, no error) are filtered out. Optional ?kind=... narrows to one kind. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
Output
Get warehouse saved queries activity
Get warehouse saved queries activity
POSTHOG_GET_WAREHOUSE_SAVED_QUERIES_ACTIVITYRetrieve activity log details for a specific PostHog warehouse saved query, including recorded changes and the users who made them.Input Parameters
Output
Get warehouse saved query
Get warehouse saved query
POSTHOG_GET_WAREHOUSE_SAVED_QUERYRetrieve a specific PostHog warehouse saved query, including its creator, query definition, execution status, and latest execution metadata.Input Parameters
Output
Get warehouse table
Get warehouse table
POSTHOG_GET_WAREHOUSE_TABLERetrieve details of a specific data warehouse table by its UUID. Use this to inspect warehouse table configuration, credentials, schema, and format.Input Parameters
Output
Get Warehouse Tables
Get Warehouse Tables
POSTHOG_GET_WAREHOUSE_TABLESTool 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
Output
Get web experiment
Get web experiment
POSTHOG_GET_WEB_EXPERIMENTTool 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
Output
Get web vitals
Get web vitals
POSTHOG_GET_WEB_VITALSTool 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
Output
Initiate domain verification with saml config
Initiate domain verification with saml config
POSTHOG_INITIATE_DOMAIN_VERIFICATION_WITH_SAML_CONFIGInitiates 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
Output
Create Notebook Kernel Inspect
Create Notebook Kernel Inspect
POSTHOG_INSPECT_NOTEBOOK_CODEInspect notebook kernel in a PostHog project. The signature and docstring of the name at the cursor in a Python cell, from the notebook’s running kernel. Returns found=false when no kernel is running or the kernel is busy. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Notebook Sql V2 Runs Interrupt
Create Notebook Sql V2 Runs Interrupt
POSTHOG_INTERRUPT_NOTEBOOK_CELL_RUNInterrupt notebook SQL run in a PostHog project. Stop a running cell. Idempotent: interrupting an already-finished run returns its outcome unchanged. Flag-gated (revamped-py-notebooks). PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Notebook Runs Interrupt
Create Notebook Runs Interrupt
POSTHOG_INTERRUPT_NOTEBOOK_RUNInterrupt notebook run in a PostHog project. Stop a whole-notebook run and the cell it is on. Idempotent: stopping a run that already finished returns its outcome unchanged. Flag-gated (revamped-py-notebooks). PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Canvas Actions Invoke
Create Canvas Actions Invoke
Launch Experiment
Launch Experiment
Launch Survey
Launch Survey
POSTHOG_LAUNCH_SURVEYLaunch survey in a PostHog project. Launch a survey by setting start_date to the current time. No-op if the survey is already launched (start_date set in the past) — returns the existing state unchanged. Does not affect archived surveys or surveys with an end_date in the past; unarchive or extend the end_date first.Input Parameters
Output
Get Account Notebook
Get Account Notebook
POSTHOG_LIST_ACCOUNT_NOTEBOOKSList account notebooks in a PostHog project. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
Output
List Action Selector Match Changes
List Action Selector Match Changes
List alerts for project
List alerts for project
POSTHOG_LIST_ALERTSTool 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
Output
List all projects across organizations
List all projects across organizations
List and filter project events
List and filter project events
POSTHOG_LIST_AND_FILTER_PROJECT_EVENTSThis 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
Output
List and manage project annotations
List and manage project annotations
List and manage project feature flags
List and manage project feature flags
POSTHOG_LIST_AND_MANAGE_PROJECT_FEATURE_FLAGSList 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
Output
List Batch Export Runs
List Batch Export Runs
POSTHOG_LIST_BATCH_EXPORT_RUNSList 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
Output
List conversations tickets
List conversations tickets
POSTHOG_LIST_CONVERSATIONS_TICKETSList a page of conversation tickets for a project, with optional pagination. The returned person object does not retain person fields.Input Parameters
Output
List dashboard sharing configs
List dashboard sharing configs
POSTHOG_LIST_DASHBOARD_SHARING_CONFIGSRetrieve the sharing configuration for a specified dashboard in a PostHog project using a personal API key. The response is modeled as a sharing configuration object.Input Parameters
Output
List Dashboard Widget Catalog
List Dashboard Widget Catalog
POSTHOG_LIST_DASHBOARD_WIDGET_CATALOGRetrieve widget catalog in a PostHog project. List registered dashboard widget types and per-type config_schema documentation for agents.Input Parameters
Output
List endpoints for project
List endpoints for project
List endpoint versions
List endpoint versions
POSTHOG_LIST_ENDPOINT_VERSIONSList versions for a specific PostHog endpoint using the project ID and endpoint name. Limit and offset can be supplied to request a page of version history.Input Parameters
Output
List error tracking autocapture controls
List error tracking autocapture controls
POSTHOG_LIST_ERROR_TRACKING_AUTOCAPTURE_CONTROLSTool 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
Output
List error tracking issues
List error tracking issues
List Experiment Matching Ids
List Experiment Matching Ids
POSTHOG_LIST_EXPERIMENT_MATCHING_IDSRetrieve matching experiment IDs in a PostHog project. Get IDs of all experiments matching the current list filters. Accepts the same query params as the list endpoint and returns only IDs of experiments the user has permission to edit.Input Parameters
["growth", "checkout"].Output
List Experiment Prompt Templates
List Experiment Prompt Templates
List experiment saved metrics
List experiment saved metrics
POSTHOG_LIST_EXPERIMENT_SAVED_METRICSTool 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
Output
List Experiment Session Context
List Experiment Session Context
POSTHOG_LIST_EXPERIMENT_SESSION_CONTEXTRetrieve session context in a PostHog project. Resolve which experiments (and variants) a session recording saw. Variants come from the session’s $feature_flag_called events and stamped $feature/<key> event properties — flag evaluation, which may differ from an experiment’s exposure criteria.Input Parameters
Output
List external data source jobs
List external data source jobs
List Feature Flag My Flags
List Feature Flag My Flags
POSTHOG_LIST_FEATURE_FLAG_MY_FLAGSList current user’s flags in a PostHog project.Input Parameters
Output
List feature flag role access details
List feature flag role access details
POSTHOG_LIST_FEATURE_FLAG_ROLE_ACCESS_DETAILSThis 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
Output
List file system resources
List file system resources
POSTHOG_LIST_FILE_SYSTEMTool 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
Output
List Group Activity
List Group Activity
List specific type groups with pagination
List specific type groups with pagination
POSTHOG_LIST_GROUPS_BY_TYPEList groups of a specific group type in a project, using a required search term and optional pagination cursor. Provide the group type index; valid group types can be listed via /api/:project_id/groups_types/.Input Parameters
Output
List Heatmap Events
List Heatmap Events
POSTHOG_LIST_HEATMAP_EVENTSRetrieve heatmap events in a PostHog project. Drill into the individual session interactions behind one or more heatmap coordinates. Pass the ‘points’ you want to inspect (from the heatmaps list response) to get the underlying per-session events, so you can jump to the session recordings that produced a hotspot. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
unique_visitors - unique_visitors * total_count - total_countOutput
List Insight Trending
List Insight Trending
POSTHOG_LIST_INSIGHT_TRENDINGRetrieve trending insights in a PostHog project. Returns insights ranked by view count over the last N days (default 7), highest first. Each result includes the same metadata as the standard insights list, plus a view_count and up to 3 recent viewers. Useful for surfacing the most-used insights in a project. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
dashboards field in insight payloads. Once opt-in enforcement is enabled, API-token callers stop receiving it by default; use dashboard_tiles instead.Output
List live debugger breakpoint hits
List live debugger breakpoint hits
POSTHOG_LIST_LIVE_DEBUGGER_BREAKPOINT_HITSTool 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
Output
List active live debugger breakpoints
List active live debugger breakpoints
POSTHOG_LIST_LIVE_DEBUGGER_BREAKPOINTS_ACTIVEFetch active live debugger breakpoints for a PostHog project, with optional enabled status, filename, or repository filters. Returns breakpoints from the response’s results array; if that array is absent, the returned list is empty.Input Parameters
Output
List LLM Prompts
List LLM Prompts
POSTHOG_LIST_LLM_PROMPTSList one page of a project’s LLM prompts with filtering and sorting. Use to discover prompts and their versions, labels, and content. Follow next using limit and offset to retrieve more pages; this action does not auto-page.Input Parameters
Output
List Notebook Kernel Compute Options
List Notebook Kernel Compute Options
POSTHOG_LIST_NOTEBOOK_KERNEL_COMPUTE_OPTIONSRetrieve notebook compute options in a PostHog project. Compute rates, presets, and the sizes the kernel config endpoint accepts. Static per region, so a client can fetch it once and price any shape a user picks. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
List notebooks with filters and pagination
List notebooks with filters and pagination
POSTHOG_LIST_NOTEBOOKSList notebooks in a PostHog project, with optional filters and pagination. The notebook API is in early access and can have breaking changes without announcement.Input Parameters
Output
List or delete persons with optional filters
List or delete persons with optional filters
POSTHOG_LIST_OR_DELETE_PERSONS_WITH_OPTIONAL_FILTERSList persons in a PostHog project with optional filters and pagination.Input Parameters
Output
List organization s batch exports with pagination
List organization s batch exports with pagination
List organization domains with pagination
List organization domains with pagination
POSTHOG_LIST_ORGANIZATION_DOMAINSFetch 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
Output
List organization integrations
List organization integrations
POSTHOG_LIST_ORGANIZATION_INTEGRATIONSTool 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
Output
List organization invites with pagination
List organization invites with pagination
POSTHOG_LIST_ORGANIZATION_INVITESRetrieve 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
Output
List organization members with pagination
List organization members with pagination
POSTHOG_LIST_ORGANIZATION_MEMBERSList 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
Output
List organization s pipeline destinations
List organization s pipeline destinations
List Organization's Pipeline Frontend Apps
List Organization's Pipeline Frontend Apps
POSTHOG_LIST_ORGANIZATION_PIPELINE_FRONTEND_APPSRetrieve 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
Output
List organization s pipeline import apps
List organization s pipeline import apps
POSTHOG_LIST_ORGANIZATION_PIPELINE_IMPORT_APPSRetrieve 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
Output
List organization s pipeline transformations
List organization s pipeline transformations
List Organization Plugins with Pagination
List Organization Plugins with Pagination
POSTHOG_LIST_ORGANIZATION_PLUGINSRetrieve 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
Output
List projects in organization with pagination
List projects in organization with pagination
POSTHOG_LIST_ORGANIZATION_PROJECTSList projects for a specified organization, with optional limit and offset pagination.Input Parameters
Output
List organization proxy records
List organization proxy records
POSTHOG_LIST_ORGANIZATION_PROXY_RECORDSRetrieve 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
Output
List organization roles with pagination
List organization roles with pagination
POSTHOG_LIST_ORGANIZATION_ROLESList 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
Output
List Person Cohorts
List Person Cohorts
List Person Deletion Status
List Person Deletion Status
POSTHOG_LIST_PERSON_DELETION_STATUSList person deletion status in a PostHog project. List the status of queued event deletions for persons. When you delete a person with delete_events=true, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. Returns one page; use the documented pagination parameters for additional pages.Input Parameters
Output
List Person Properties At Time
List Person Properties At Time
POSTHOG_LIST_PERSON_PROPERTIES_AT_TIMERetrieve person properties at a time in a PostHog project. Get person properties as they existed at a specific point in time.Input Parameters
Output
List pipeline destination configs with pagination
List pipeline destination configs with pagination
POSTHOG_LIST_PIPELINE_DESTINATION_CONFIGSList 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
Output
List pipeline frontend app configs
List pipeline frontend app configs
POSTHOG_LIST_PIPELINE_FRONTEND_APP_CONFIGSList 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
Output
List product tours
List product tours
POSTHOG_LIST_PRODUCT_TOURSTool 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
Output
List project actions with pagination and filters
List project actions with pagination and filters
POSTHOG_LIST_PROJECT_ACTIONSRetrieve a paginated list of project actions, including IDs, names, descriptions, and metadata. Supports limit and offset pagination and a JSON or CSV format parameter; requires personal API key authentication.Input Parameters
Output
List project batch exports with pagination
List project batch exports with pagination
POSTHOG_LIST_PROJECT_BATCH_EXPORTSRetrieve 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
Output
List project configuration plugin logs
List project configuration plugin logs
POSTHOG_LIST_PROJECT_CONFIGURATION_PLUGIN_LOGSRetrieve 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
Output
List project dashboard collaborators
List project dashboard collaborators
POSTHOG_LIST_PROJECT_DASHBOARD_COLLABORATORSRetrieve 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
Output
List project dashboards with pagination
List project dashboards with pagination
POSTHOG_LIST_PROJECT_DASHBOARDSGet paginated dashboards for a project by ID, using ‘limit’ and ‘offset’. Must authenticate with PersonalAPIKeyAuth. Includes count, pagination, and dashboard details.Input Parameters
Output
List project dashboard templates
List project dashboard templates
POSTHOG_LIST_PROJECT_DASHBOARD_TEMPLATESRetrieve 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
Output
List project early access features
List project early access features
POSTHOG_LIST_PROJECT_EARLY_ACCESS_FEATURESRetrieve 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
Output
List project experiments with pagination
List project experiments with pagination
POSTHOG_LIST_PROJECT_EXPERIMENTSGet 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
Output
List project export items with pagination
List project export items with pagination
POSTHOG_LIST_PROJECT_EXPORT_ITEMSRetrieve 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
Output
List project group types by id
List project group types by id
POSTHOG_LIST_PROJECT_GROUP_TYPESList 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
Output
List project membership details
List project membership details
POSTHOG_LIST_PROJECT_MEMBERSHIP_DETAILSRetrieve 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
Output
List project pipeline configurations
List project pipeline configurations
POSTHOG_LIST_PROJECT_PIPELINE_CONFIGURATIONSList 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
Output
Listprojectpipelineimportconfigs
Listprojectpipelineimportconfigs
POSTHOG_LIST_PROJECT_PIPELINE_IMPORT_CONFIGSList 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
Output
List project plugin configurations
List project plugin configurations
POSTHOG_LIST_PROJECT_PLUGIN_CONFIGURATIONSList 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
Output
List project session recordings
List project session recordings
POSTHOG_LIST_PROJECT_SESSION_RECORDINGSRetrieve 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
Output
List project subscriptions with pagination
List project subscriptions with pagination
POSTHOG_LIST_PROJECT_SUBSCRIPTIONSRetrieve 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
Output
List paginated surveys for a project
List paginated surveys for a project
POSTHOG_LIST_PROJECT_SURVEYSGet 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
Output
List Role Memberships Paginated
List Role Memberships Paginated
POSTHOG_LIST_ROLE_MEMBERSHIPSList 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
Output
List of project s session recording playlists
List of project s session recording playlists
POSTHOG_LIST_SESSION_RECORDING_PLAYLISTSList 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
Output
List session recording sharing configs
List session recording sharing configs
POSTHOG_LIST_SESSION_RECORDING_SHARING_CONFIGSRetrieve 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
Output
List signal reports
List signal reports
POSTHOG_LIST_SIGNAL_REPORTSList signal reports for a PostHog project with filters and pagination.Input Parameters
Output
List Survey Question Labels
List Survey Question Labels
POSTHOG_LIST_SURVEY_QUESTION_LABELSRetrieve survey question labels in a PostHog project. Return a slim list of question labels for the team’s surveys. Used by the frontend to resolve $survey_response_<question_id> property keys into human-readable question text without loading the full survey payload.Input Parameters
Output
List unused organization pipeline transformations
List unused organization pipeline transformations
List users with staff filter and pagination
List users with staff filter and pagination
POSTHOG_LIST_USERS_WITH_STAFF_FILTER_AND_PAGINATIONAPI 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
Output
List warehouse saved queries
List warehouse saved queries
POSTHOG_LIST_WAREHOUSE_SAVED_QUERIESTool 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
Output
List web experiments
List web experiments
POSTHOG_LIST_WEB_EXPERIMENTSTool 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
Output
Manage feature flag enrichment for usage dashboard
Manage feature flag enrichment for usage dashboard
Crud operations for project annotations
Crud operations for project annotations
POSTHOG_MANAGE_PROJECT_ANNOTATIONSCreate an annotation for a PostHog project.Input Parameters
dashboard_item- insight *dashboard- dashboard *project- project *organization- organization
Output
Manage project feature flags for local evaluation
Manage project feature flags for local evaluation
POSTHOG_MANAGE_PROJECT_FEATURE_FLAGS_FOR_LOCAL_EVALUATIONRetrieve 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
Output
Mark dashboard template as deleted
Mark dashboard template as deleted
Mark insight as viewed with configurable format
Mark insight as viewed with configurable format
POSTHOG_MARK_INSIGHT_AS_VIEWED_WITH_CONFIGURABLE_FORMATMarks 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
Output
Create project timing insights
Create project timing insights
POSTHOG_MARK_INSIGHTS_AS_VIEWEDRecord project insights as viewed by submitting their IDs to the insights timing endpoint. The configured connection uses a personal API key.Input Parameters
Output
Prevent hard delete notebook by flagging
Prevent hard delete notebook by flagging
POSTHOG_MARK_NOTEBOOK_AS_DELETEDSend a delete request for a notebook identified by project ID and short ID. A 405 response is reported as hard deletion not allowed; a 404 is reported as notebook not found.Input Parameters
Output
Migrate Experiment
Migrate Experiment
Move dashboard tile
Move dashboard tile
POSTHOG_MOVE_DASHBOARD_TILEMove a tile from one dashboard to another in a PostHog project.Input Parameters
Output
Create Dashboard Move Tile
Create Dashboard Move Tile
POSTHOG_MOVE_DASHBOARD_TILE_TO_DASHBOARDMove dashboard tile in a PostHog project.Input Parameters
Output
Move file system item
Move file system item
Update alert configuration
Update alert configuration
POSTHOG_PATCH_ALERTTool 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
Output
Patch Batch Export
Patch Batch Export
POSTHOG_PATCH_BATCH_EXPORTUpdate 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
Output
Mark product onboarding complete
Mark product onboarding complete
POSTHOG_PATCH_COMPLETE_PRODUCT_ONBOARDINGTool 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
Output
Patch Customer Profile Config
Patch Customer Profile Config
POSTHOG_PATCH_CUSTOMER_PROFILE_CONFIGUpdate 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
Output
Patch Dataset
Patch Dataset
Patch Dataset Item
Patch Dataset Item
POSTHOG_PATCH_DATASET_ITEMPartially update a dataset item by ID in a PostHog project, including its input, output, metadata, reference fields, or deleted status.Input Parameters
Output
Patch endpoint
Patch endpoint
POSTHOG_PATCH_ENDPOINTTool 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
Output
Patch error tracking autocapture controls
Patch error tracking autocapture controls
POSTHOG_PATCH_ERROR_TRACKING_AUTOCAPTURE_CONTROLSPartially 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
Output
Patch Evaluation
Patch Evaluation
POSTHOG_PATCH_EVALUATIONUpdate an evaluation by patching specific fields. Use when you need to modify evaluation settings like description, enabled status, or configuration.Input Parameters
Output
Partial experiment update in project
Partial experiment update in project
POSTHOG_PATCH_EXPERIMENTPartially update an experiment in a project using the project ID and experiment ID. Returns updated details and requires authentication.Input Parameters
Output
Patch experiment saved metric
Patch experiment saved metric
POSTHOG_PATCH_EXPERIMENT_SAVED_METRICTool 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
Output
Patch External Data Source
Patch External Data Source
POSTHOG_PATCH_EXTERNAL_DATA_SOURCETool 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
Output
Patch file system
Patch file system
POSTHOG_PATCH_FILE_SYSTEMTool 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
Output
Patch file system shortcut
Patch file system shortcut
POSTHOG_PATCH_FILE_SYSTEM_SHORTCUTTool 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
Output
Update group usage metric
Update group usage metric
POSTHOG_PATCH_GROUPS_TYPES_METRICSTool 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
Output
Patch hog function
Patch hog function
POSTHOG_PATCH_HOG_FUNCTIONTool 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
Output
Patch Insight Variable
Patch Insight Variable
POSTHOG_PATCH_INSIGHT_VARIABLEUpdate 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
Output
Patch live debugger breakpoint
Patch live debugger breakpoint
POSTHOG_PATCH_LIVE_DEBUGGER_BREAKPOINTTool 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
Output
Update organization domain properties
Update organization domain properties
Update partial role details in organization
Update partial role details in organization
Patch persisted folder
Patch persisted folder
POSTHOG_PATCH_PERSISTED_FOLDERTool 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
Output
Person partial update via project id
Person partial update via project id
Patch product tour
Patch product tour
POSTHOG_PATCH_PRODUCT_TOURTool 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
Output
Update project action with partial data
Update project action with partial data
POSTHOG_PATCH_PROJECT_ACTIONPartially update a project action by project ID and action ID. Supports a CSV or JSON format parameter and requires action:write permission.Input Parameters
Output
Partial update project annotation
Partial update project annotation
POSTHOG_PATCH_PROJECT_ANNOTATIONPartially update an annotation in a PostHog project by its ID.Input Parameters
dashboard_item- insight *dashboard- dashboard *project- project *organization- organization
Output
Update partial project cohort details
Update partial project cohort details
POSTHOG_PATCH_PROJECT_COHORTUpdate 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
Output
Partial update of a project s dashboard
Partial update of a project s dashboard
POSTHOG_PATCH_PROJECT_DASHBOARDEndpoint 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
Output
Partial update of a project s feature flag
Partial update of a project s feature flag
Partial update of a project insight
Partial update of a project insight
POSTHOG_PATCH_PROJECT_INSIGHTThe 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
Output
Update project member role by uuid
Update project member role by uuid
POSTHOG_PATCH_PROJECT_MEMBERUpdate 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
Output
Partial update of project notebook
Partial update of project notebook
POSTHOG_PATCH_PROJECT_NOTEBOOKPartially update a notebook in a PostHog project by its short ID. The notebook API is in early access and can have breaking changes without announcement.Input Parameters
Output
Partially update project property definition
Partially update project property definition
Update partial subscription details
Update partial subscription details
POSTHOG_PATCH_PROJECT_SUBSCRIPTIONPATCH /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
daily- Daily *weekly- Weekly *monthly- Monthly *yearly- Yearly
Output
Update partial survey details
Update partial survey details
POSTHOG_PATCH_PROJECT_SURVEYUpdate 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
popover- popover *widget- widget *button- button *email- email *full_screen- full screen *api- api
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 } Output
Update session recording playlist partially
Update session recording playlist partially
POSTHOG_PATCH_SESSION_RECORDING_PLAYLISTUpdate 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
Output
Update user profile
Update user profile
POSTHOG_PATCH_USERTool 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
Output
Patch warehouse saved query
Patch warehouse saved query
POSTHOG_PATCH_WAREHOUSE_SAVED_QUERYTool 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
Output
Patch warehouse tables
Patch warehouse tables
POSTHOG_PATCH_WAREHOUSE_TABLESTool 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
Output
Patch web experiment
Patch web experiment
POSTHOG_PATCH_WEB_EXPERIMENTTool 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
Output
Pause Batch Export
Pause Batch Export
POSTHOG_PAUSE_BATCH_EXPORTPause 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
Output
Pause Experiment
Pause Experiment
Pause Organization Batch Export
Pause Organization Batch Export
Create Notebook Widgets Pin
Create Notebook Widgets Pin
Create Endpoint Materialization Preview
Create Endpoint Materialization Preview
POSTHOG_PREVIEW_ENDPOINT_MATERIALIZATIONPreview materialization transform in a PostHog project. Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.Input Parameters
Output
Project Funnel Advanced Analytics
Project Funnel Advanced Analytics
POSTHOG_PROJECT_FUNNEL_ADVANCED_ANALYTICSCreate 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
funnel_window_interval and funnel_window_interval_typeOutput
Post Project Trends With Filters
Post Project Trends With Filters
POSTHOG_PROJECT_TREND_ANALYTICSThe /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
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.A + B or (A-B)/B. The letters correspond to the order of the events or actions lists.event (default): a property key - person: a person property key - cohort: an array of cohort IDs (ie [9581,5812])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.Output
Create Notebook Widgets Publish
Create Notebook Widgets Publish
POSTHOG_PUBLISH_NOTEBOOK_WIDGETPublish notebook widget in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Experiment Session Buckets
Create Experiment Session Buckets
POSTHOG_QUERY_EXPERIMENT_SESSION_BUCKETQuery an experiment session bucket in a PostHog project and return matching session IDs for recordings.Input Parameters
fired_any - fired_any * no_metric_activity - no_metric_activity * funnel_dropoff - funnel_dropoffOutput
Query logs
Query logs
Create Metric Query
Create Metric Query
Create Tracing Spans Query
Create Tracing Spans Query
Rearrange frontend app pipeline configs
Rearrange frontend app pipeline configs
POSTHOG_REARRANGE_FRONTEND_APP_PIPELINE_CONFIGSRearrange (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
Output
Rearrange pipeline transformation configs
Rearrange pipeline transformation configs
POSTHOG_REARRANGE_PIPELINE_TRANSFORMATION_CONFIGSRearrange pipeline transformation configurations for a project, including order, enabled status, and configuration settings. The configured connection uses a personal API key.Input Parameters
Output
Rearrange project import app configurations
Rearrange project import app configurations
POSTHOG_REARRANGE_PROJECT_IMPORT_APP_CONFIGURATIONSRearrange 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
Output
Rearrange project pipeline destination configs
Rearrange project pipeline destination configs
POSTHOG_REARRANGE_PROJECT_PIPELINE_DESTINATION_CONFIGSRearrange pipeline destination configurations for a project, including order, enabled status, and configuration settings. The configured connection uses a personal API key.Input Parameters
Output
Create Experiment Metrics Recalculation
Create Experiment Metrics Recalculation
POSTHOG_RECALCULATE_EXPERIMENT_METRICSRecalculate experiment metrics in a PostHog project. Trigger a batch recalculation of all metrics for this experiment.Input Parameters
manual - Manual * manual_retry - Manual Retry * cold_run - Cold Run * stale_refresh - Stale Refresh * heal_latest_run - Heal Latest Run * experiment_config_change - Experiment Config Change * metric_config_change - Metric Config ChangeOutput
Create experiment timeseries recalculation
Create experiment timeseries recalculation
POSTHOG_RECALCULATE_EXPERIMENT_TIMESERIESTool 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
Output
Reconfigure plugin order and status in project
Reconfigure plugin order and status in project
POSTHOG_RECONFIGURE_PLUGIN_ORDER_AND_STATUS_IN_PROJECTReconfigure the order, enabled status, and settings of plugin configurations in a project. The configured connection uses a personal API key.Input Parameters
Output
Create Dashboard Sharing Refresh
Create Dashboard Sharing Refresh
Create Insight Sharing Refresh
Create Insight Sharing Refresh
Create Notebook Sharing Refresh
Create Notebook Sharing Refresh
POSTHOG_REFRESH_NOTEBOOK_SHARINGRotate a notebook sharing access token. Existing share links expire; distribute the returned token to continue sharing. The notebook API is early access.Input Parameters
Output
Create Dashboard Reorder Tiles
Create Dashboard Reorder Tiles
POSTHOG_REORDER_DASHBOARD_TILESReorder dashboard tiles in a PostHog project.Input Parameters
preserve - preserve * two_column - two_column * three_column - three_column * full_width - full_widthOutput
Replace Desktop Recording
Replace Desktop Recording
POSTHOG_REPLACE_DESKTOP_RECORDINGReplace 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
Output
Reset Experiment
Reset Experiment
Reset person distinct ID
Reset person distinct ID
POSTHOG_RESET_PERSON_DISTINCT_IDReset 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
Output
Resume Experiment
Resume Experiment
Retrieve async query status by id
Retrieve async query status by id
Retrieve last viewed insights for user
Retrieve last viewed insights for user
POSTHOG_RETRIEVE_LAST_VIEWED_INSIGHTS_FOR_USERReturns basic details about the last 5 insights viewed by this user. Most recently viewed first.Input Parameters
Output
Retrieve matching events for session recording
Retrieve matching events for session recording
POSTHOG_RETRIEVE_MATCHING_EVENTS_FOR_SESSION_RECORDINGRequest matching events for session recordings in a PostHog project. The action does not expose a session ID or event/action filter and uses the configured personal API key.Input Parameters
Output
Retrieve notebook activity for project
Retrieve notebook activity for project
POSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_FOR_PROJECTRetrieve notebook activity for a PostHog project. The notebook API is in early access and may change without announcement.Input Parameters
Output
Retrieve notebook activity log
Retrieve notebook activity log
POSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_LOGRetrieve the activity log for a specific notebook in a PostHog project. The notebook API is in early access and may change without announcement.Input Parameters
Output
Retrieve notebook details
Retrieve notebook details
POSTHOG_RETRIEVE_NOTEBOOK_DETAILSRetrieve details of a specific notebook in a PostHog project. The notebook API is in early access and may change without announcement.Input Parameters
Output
Retrieve or delete person retention data
Retrieve or delete person retention data
Retrieve or delete project persons funnel data
Retrieve or delete project persons funnel data
POSTHOG_RETRIEVE_OR_DELETE_PROJECT_PERSONS_FUNNEL_DATARetrieves 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
Output
Retrieve organization pipeline frontend app details
Retrieve organization pipeline frontend app details
Retrieve Org Pipeline Repo Details
Retrieve Org Pipeline Repo Details
Retrieve org pipeline transformation activity
Retrieve org pipeline transformation activity
Retrieve organization pipeline unsubscribe configs
Retrieve organization pipeline unsubscribe configs
POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_UNSUBSCRIBE_CONFIGSRetrieve 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
Output
Retrieve organization plugin activity
Retrieve organization plugin activity
Retrieve organization plugin details
Retrieve organization plugin details
POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_DETAILSRetrieve 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
Output
Retrieve organization plugin repository details
Retrieve organization plugin repository details
Retrieve organization plugin unsubscribe configs
Retrieve organization plugin unsubscribe configs
POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_UNSUBSCRIBE_CONFIGSRetrieve 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
Output
Retrieve organization project details
Retrieve organization project details
Retrieve organization role details
Retrieve organization role details
POSTHOG_RETRIEVE_ORGANIZATION_ROLE_DETAILSRetrieve 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
Output
Retrieve organization s unused pipeline apps
Retrieve organization s unused pipeline apps
Retrieve paginated organization list
Retrieve paginated organization list
POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LISTRetrieve 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
Output
Retrieve persisted folder
Retrieve persisted folder
POSTHOG_RETRIEVE_PERSISTED_FOLDERTool 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
Output
Retrieve person s activity and delete options
Retrieve person s activity and delete options
Retrieve person details by id
Retrieve person details by id
Retrieve persons funnel correlation data
Retrieve persons funnel correlation data
POSTHOG_RETRIEVE_PERSONS_FUNNEL_CORRELATION_DATANote: 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
Output
Retrieve person property values
Retrieve person property values
POSTHOG_RETRIEVE_PERSON_VALUES_BY_PROJECTRetrieve 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
Output
Retrieve pipeline destination activity
Retrieve pipeline destination activity
POSTHOG_RETRIEVE_PIPELINE_DESTINATION_ACTIVITYRetrieve pipeline destination activity for an organization, with optional limit and offset pagination. Results contain activity entries with associated users, item IDs, timestamps, and details.Input Parameters
Output
Retrieve pipeline destination config details
Retrieve pipeline destination config details
POSTHOG_RETRIEVE_PIPELINE_DESTINATION_CONFIG_DETAILSRetrieve 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
Output
Retrieve pipeline destination details
Retrieve pipeline destination details
Retrieve pipeline destination plugin details
Retrieve pipeline destination plugin details
Retrieve pipeline frontend app activity
Retrieve pipeline frontend app activity
Retrieve pipeline frontend app details
Retrieve pipeline frontend app details
POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_DETAILSRetrieve 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 actionInput Parameters
Output
Retrieve pipeline frontend app source details
Retrieve pipeline frontend app source details
Retrieve pipeline frontend plugin config
Retrieve pipeline frontend plugin config
POSTHOG_RETRIEVE_PIPELINE_FRONTEND_PLUGIN_CONFIGRetrieve the frontend configuration for a pipeline frontend app by project ID and config ID. The response can include configuration data, enabled status, order, plugin information, and timestamps.Input Parameters
Output
Retrieve pipeline import apps activity
Retrieve pipeline import apps activity
Retrieve pipeline plugin details by id
Retrieve pipeline plugin details by id
POSTHOG_RETRIEVE_PIPELINE_PLUGIN_DETAILS_BY_IDRetrieve 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
Output
Retrieve Pipeline Plugin Source
Retrieve Pipeline Plugin Source
Retrieve pipeline transformation frontend config
Retrieve pipeline transformation frontend config
POSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_FRONTEND_CONFIGRetrieve 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
Output
Retrieve plugin source details
Retrieve plugin source details
Retrieve plugin update info
Retrieve plugin update info
Retrieve plugin update status
Retrieve plugin update status
Retrieve project action details by id
Retrieve project action details by id
POSTHOG_RETRIEVE_PROJECT_ACTION_DETAILS_BY_IDGet 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
Output
Retrieve project activity details
Retrieve project activity details
POSTHOG_RETRIEVE_PROJECT_ACTIVITY_DETAILSRetrieve 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
Output
Retrieve project activity insights
Retrieve project activity insights
POSTHOG_RETRIEVE_PROJECT_ACTIVITY_INSIGHTSRetrieve 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
Output
Retrieve project activity log with pagination
Retrieve project activity log with pagination
POSTHOG_RETRIEVE_PROJECT_ACTIVITY_LOG_WITH_PAGINATIONRetrieve 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
Output
Retrieve project annotation details
Retrieve project annotation details
Retrieve project cohort details
Retrieve project cohort details
POSTHOG_RETRIEVE_PROJECT_COHORT_DETAILSRetrieve 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
Output
Retrieve project cohorts activity log
Retrieve project cohorts activity log
POSTHOG_RETRIEVE_PROJECT_COHORTS_ACTIVITY_LOGRetrieve activity log entries for a project’s cohorts, including activity details, the user who performed the action, and timestamps. Requires a project ID and personal API key authentication with activity_log:read permission.Input Parameters
Output
Retrieve project cohorts with pagination
Retrieve project cohorts with pagination
POSTHOG_RETRIEVE_PROJECT_COHORTS_WITH_PAGINATIONRetrieve 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
Output
Retrieve project early access feature details
Retrieve project early access feature details
POSTHOG_RETRIEVE_PROJECT_EARLY_ACCESS_FEATURE_DETAILSRetrieve 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
Output
Retrieve project event details by id
Retrieve project event details by id
POSTHOG_RETRIEVE_PROJECT_EVENT_DETAILS_BY_IDRetrieve 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
Output
Retrieve project event values
Retrieve project event values
POSTHOG_RETRIEVE_PROJECT_EVENT_VALUESRequest values for an event property key in a project, with CSV or JSON format selection. PostHog requires an event name for this endpoint when using a personal API key, but this tool does not expose that parameter.Input Parameters
Output
Retrieve project experiment results
Retrieve project experiment results
POSTHOG_RETRIEVE_PROJECT_EXPERIMENT_RESULTSRetrieve 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
Output
Retrieve project export details
Retrieve project export details
POSTHOG_RETRIEVE_PROJECT_EXPORT_DETAILSRetrieve 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
Output
Retrieve project funnel correlation insights
Retrieve project funnel correlation insights
POSTHOG_RETRIEVE_PROJECT_FUNNEL_CORRELATION_INSIGHTSRetrieve 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
Output
Retrieve project group details by key and type
Retrieve project group details by key and type
POSTHOG_RETRIEVE_PROJECT_GROUP_DETAILS_BY_KEY_AND_TYPERetrieves 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
Output
Retrieve project insight activity data
Retrieve project insight activity data
POSTHOG_RETRIEVE_PROJECT_INSIGHT_ACTIVITY_DATARetrieve 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
Output
Retrieve project insight details
Retrieve project insight details
POSTHOG_RETRIEVE_PROJECT_INSIGHT_DETAILSRetrieve 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
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
Retrieve project insights with pagination
Retrieve project insights with pagination
POSTHOG_RETRIEVE_PROJECT_INSIGHTS_WITH_PAGINATIONRetrieve a paginated list of insights for a project, with creator and short ID filters and JSON/CSV format options. Use limit and offset to page through results; the limit defaults to one, and insight read permission is required.Input Parameters
Output
Retrieve project member details by uuid
Retrieve project member details by uuid
POSTHOG_RETRIEVE_PROJECT_MEMBER_DETAILS_BY_UUIDRetrieve 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
Output
Retrieve project person activity
Retrieve project person activity
Retrieve project session values
Retrieve project session values
POSTHOG_RETRIEVE_PROJECT_SESSION_VALUESRetrieve session property values for a project and a specified property key. Returns a list of values with pagination information.Input Parameters
Output
Retrieve project subscription details
Retrieve project subscription details
POSTHOG_RETRIEVE_PROJECT_SUBSCRIPTION_DETAILSRetrieve 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
Output
Retrieve project trend insights
Retrieve project trend insights
POSTHOG_RETRIEVE_PROJECT_TREND_INSIGHTSRetrieve saved insights from a PostHog project, optionally selecting an insight by short ID. Use limit and offset for pagination and choose CSV or JSON output to access previously created analysis reports.Input Parameters
Output
Retrieve properties and events association
Retrieve properties and events association
POSTHOG_RETRIEVE_PROPERTIES_AND_EVENTS_ASSOCIATIONAllows 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_nameInput Parameters
Output
Retrieve property definition details
Retrieve property definition details
POSTHOG_RETRIEVE_PROPERTY_DEFINITION_DETAILSRetrieve details of a specific property definition by UUID within a project using personal API key authentication with read access.Input Parameters
Output
Retrieve Retention Insights (Deprecated)
Retrieve Retention Insights (Deprecated)
POSTHOG_RETRIEVE_RETENTION_INSIGHTSDEPRECATED: 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
Output
Retrieve session property definitions
Retrieve session property definitions
POSTHOG_RETRIEVE_SESSION_PROPERTY_DEFINITIONSRetrieve session property definitions for a specified project. Returns a page of definitions with pagination metadata.Input Parameters
Output
Retrieve session recording details
Retrieve session recording details
POSTHOG_RETRIEVE_SESSION_RECORDING_DETAILSRetrieve 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
Output
Retrieve session recording error clusters
Retrieve session recording error clusters
POSTHOG_RETRIEVE_SESSION_RECORDING_ERROR_CLUSTERSRetrieve session recording error clusters for a project. A 404 is returned as a not-found result with an empty error-clusters list, which does not by itself establish that no clusters exist.Input Parameters
Output
Retrieve recordings from playlist
Retrieve recordings from playlist
POSTHOG_RETRIEVE_SESSION_RECORDING_PLAYLIST_DETAILSRetrieve 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
Output
Retrieve session recording properties
Retrieve session recording properties
POSTHOG_RETRIEVE_SESSION_RECORDING_PROPERTIES_BY_PROJECT_IDRetrieve session recording properties for a project, with limit and offset pagination. Non-success responses are returned as error information; a 404 is marked not found and a 403 is marked permission denied.Input Parameters
Output
Retrieve session recording snapshots
Retrieve session recording snapshots
POSTHOG_RETRIEVE_SESSION_RECORDING_SNAPSHOTSRetrieve the available snapshot sources for a session recording in a project. The request identifies the project and recording but does not select a source for fetching its snapshots.Input Parameters
Output
Retrieve specific batch export details
Retrieve specific batch export details
POSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_DETAILSRetrieve 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
Output
Retrieve specific batch export run details
Retrieve specific batch export run details
POSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_RUN_DETAILSRetrieve 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
Output
Retrieve specific domain details
Retrieve specific domain details
POSTHOG_RETRIEVE_SPECIFIC_DOMAIN_DETAILSRetrieve 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
Output
Retrieve specific exported asset content
Retrieve specific exported asset content
POSTHOG_RETRIEVE_SPECIFIC_EXPORTED_ASSET_CONTENTRetrieve the content of a specific exported asset by ID within a project as a downloadable file. Requires ‘export:read’ permission.Input Parameters
Output
Retrieve specific historical plugin export
Retrieve specific historical plugin export
POSTHOG_RETRIEVE_SPECIFIC_HISTORICAL_PLUGIN_EXPORTRetrieve historical export data for a specific plugin configuration within a project. Requires project, plugin configuration, and export item IDs and personal API key authentication.Input Parameters
Output
Retrieve specific pipeline frontend app config
Retrieve specific pipeline frontend app config
POSTHOG_RETRIEVE_SPECIFIC_PIPELINE_FRONTEND_APP_CONFIGRetrieve 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
Output
Retrieve specific project dashboard details
Retrieve specific project dashboard details
POSTHOG_RETRIEVE_SPECIFIC_PROJECT_DASHBOARD_DETAILSRetrieve 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
Output
Retrieve survey activity logs
Retrieve survey activity logs
POSTHOG_RETRIEVE_SURVEY_ACTIVITY_LOGSRetrieve 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
Output
Retrieve survey details with uuid and project id
Retrieve survey details with uuid and project id
POSTHOG_RETRIEVE_SURVEY_DETAILS_WITH_UUID_AND_PROJECT_IDRetrieve 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
Output
Retrieve survey responses count by project id
Retrieve survey responses count by project id
Retrieve unsubscribed pipeline configs
Retrieve unsubscribed pipeline configs
POSTHOG_RETRIEVE_UNSUBSCRIBED_PIPELINE_CONFIGSRetrieve 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
Output
Retrieve user profile and team details
Retrieve user profile and team details
POSTHOG_RETRIEVE_USER_PROFILE_AND_TEAM_DETAILSFetch 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
Output
Retry batch export run
Retry batch export run
POSTHOG_RETRY_BATCH_EXPORT_RUNTool 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
Output
Create Notebook Widgets Revert
Create Notebook Widgets Revert
Revoke organization invite
Revoke organization invite
Create Feature Flag Roll Out To Everyone
Create Feature Flag Roll Out To Everyone
POSTHOG_ROLL_OUT_FEATURE_FLAG_TO_EVERYONERoll flag out to everyone in a PostHog project. Serve a feature flag to every user.Input Parameters
version from your most recent read of this flag. The change is refused with 409 if anyone else changed the flag after that version. A flag written before versioning reads as null; send that back unchanged and it is read as 0, so the value a read returns is always one this accepts.Output
Run endpoint
Run endpoint
POSTHOG_RUN_ENDPOINTExecute a predefined PostHog endpoint, including HogQL queries or insights, with optional variables and filter overrides. Supports selecting a version, result limit, refresh mode and debug information.Input Parameters
Output
Create Notebook Runs
Create Notebook Runs
POSTHOG_RUN_NOTEBOOKCreate notebook run in a PostHog project. Run every SQL and Python cell of a markdown notebook, in document order, stopping at the first cell that does not finish. Returns as soon as the run starts; poll the run status endpoint until the status is terminal. Flag-gated (revamped-py-notebooks). PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Create Notebook Sql V2 Run
Create Notebook Sql V2 Run
POSTHOG_RUN_NOTEBOOK_CELLRun notebook SQL in a PostHog project. Dispatch an asynchronous run of a notebook SQL or Python cell. Returns a run_id immediately; poll the run result endpoint until the status is terminal. One run at a time per notebook. Python notebooks enable all run types. HogQL runs without a connection or kernel are always available. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
hogql - hogql * python - python{name} bound to its value before dispatch; a Python node gets them as globals in the kernel namespace. A SQL node reading a {name} that is absent here fails the dispatch.Output
Create Signal Reports Actions Run
Create Signal Reports Actions Run
POSTHOG_RUN_SIGNAL_REPORT_ACTIONRun report agent action in a PostHog project. Create a task linked to the report and start its first run in the background, with the instructions the inbox uses for the same action. ask sends your own message with the framing of the inbox’s Ask AI. The run shows in the report’s runs and counts toward the report’s task limit. Nobody can answer questions in a background run, so the agent writes a note to the report’s work log when it needs a decision.Input Parameters
ask to send your own message. * get_it_merged - Get it merged * make_it_green - Make it green * suggested_prompt - Suggested prompt * ask - Askask, where it is the question or the work you want done on the report. Optional for get_it_merged and make_it_green, where it replaces the action’s fixed request and keeps its instructions and gates: pass it when you know something the report does not, such as a merge order, a failure that is already on the base branch, or an expected conflict. Not accepted for suggested_prompt.Output
Create Notebook Collab Save
Create Notebook Collab Save
POSTHOG_SAVE_NOTEBOOK_COLLABORATION_STATESave collaborative notebook in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Save Notebook Markdown
Save Notebook Markdown
POSTHOG_SAVE_NOTEBOOK_MARKDOWNSave a full collaborative markdown notebook at its current version. Retrieve the notebook first for its short_id and version. Returns the persisted notebook with its new version. HTTP 409 means conflict; HTTP 410 means reload the notebook because the missing updates cannot be replayed. Does not execute cells or provision a kernel. This PostHog API is early access and may change.Input Parameters
Output
Create Feature Flag Set Release Condition Rollout
Create Feature Flag Set Release Condition Rollout
POSTHOG_SET_FEATURE_FLAG_RELEASE_CONDITION_ROLLOUTSet release condition rollout in a PostHog project. Set what percentage of one release condition’s audience a feature flag is served to.Input Parameters
version from your most recent read of this flag. The change is refused with 409 if anyone else changed the flag after that version. A flag written before versioning reads as null; send that back unchanged and it is read as 0, so the value a read returns is always one this accepts.filters.groups, counted from the read that produced version.filters.Output
Set Llm Prompt Labels
Set Llm Prompt Labels
POSTHOG_SET_LLM_PROMPT_LABELSUpdate LLM prompt label in a PostHog project.Input Parameters
Output
Create Experiment Ship Variant
Create Experiment Ship Variant
POSTHOG_SHIP_EXPERIMENT_VARIANTShip experiment variant in a PostHog project. Ship a variant and (optionally) end the experiment.Input Parameters
won - won * lost - lost * inconclusive - inconclusive * stopped_early - stopped_early * invalid - invalidorganization/repository format. Only used when open_cleanup_pr is true. It must be one of the team’s connected repositories (see the flag_cleanup_target action); it is then saved as the experiment’s repository. When omitted, the experiment’s saved repository, the team’s default cleanup repository, or the team’s only connected repository is used.repository as this environment’s default cleanup repository, used for experiments that have no repository of their own. Only acts when open_cleanup_pr is true and repository is provided and belongs to the team’s GitHub installation. Requires project admin access (403 otherwise).Output
Split person entities in project
Split person entities in project
POSTHOG_SPLIT_PERSON_ENTITIES_IN_PROJECTSplit distinct IDs from a person in a project. Optionally specify which distinct IDs to split off.Input Parameters
Output
Create error tracking symbol sets bulk start upload
Create error tracking symbol sets bulk start upload
POSTHOG_START_ERROR_TRACKING_SYMBOL_SETS_BULK_UPLOADInitiate a bulk upload of error tracking symbol sets for a PostHog project. The response may include an ID mapping for tracking.Input Parameters
Output
Create error tracking symbol sets start upload
Create error tracking symbol sets start upload
POSTHOG_START_ERROR_TRACKING_SYMBOL_SET_UPLOADInitiate a symbol set upload session for PostHog error tracking. The response may include a presigned S3 URL for uploading a symbol file chunk as part of the multi-step upload process.Input Parameters
Output
Stop Survey
Stop Survey
POSTHOG_STOP_SURVEYStop survey in a PostHog project. Stop a survey by setting end_date to the current time. No new responses are accepted after this; existing responses remain available. No-op if the survey already has an end_date in the past.Input Parameters
Output
Create Dashboard Subscribe Nudge
Create Dashboard Subscribe Nudge
POSTHOG_SUBSCRIBE_TO_DASHBOARD_NUDGECreate subscription nudge in a PostHog project. Send the requesting user an in-app notification suggesting they subscribe to this dashboard. Deduplicated server-side: at most one notification per user and dashboard, ever, so repeat calls return 200 with created=false.Input Parameters
Output
Summarize survey responses
Summarize survey responses
POSTHOG_SUMMARIZE_SURVEY_RESPONSESTool 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
Output
Create Feature Flag Test Evaluation
Create Feature Flag Test Evaluation
POSTHOG_TEST_FEATURE_FLAG_EVALUATIONTest feature flag evaluation in a PostHog project. Test feature flag evaluation against a specific user at an optional point in time.Input Parameters
2026-04-29T15:30:00Z or 2026-04-29T15:30:00+00:00. Naive timestamps (no timezone) are interpreted as UTC.Output
Test Hog function invocation
Test Hog function invocation
Test saved Hog function invocation
Test saved Hog function invocation
Translate text
Translate text
POSTHOG_TRANSLATE_TEXTTool 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
Output
Trigger project export with format option
Trigger project export with format option
POSTHOG_TRIGGER_PROJECT_EXPORT_WITH_FORMAT_OPTIONTrigger an export of a dashboard or insight in a PostHog project using a specified export format, returning export information.Input Parameters
image/png- image/png *application/pdf- application/pdf *text/csv- text/csv *application/vnd.openxmlformats-officedocument.spreadsheetml.sheet- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Output
Unarchive Experiment
Unarchive Experiment
Unarchive Feature Flag
Unarchive Feature Flag
Unarchive Llm Prompt
Unarchive Llm Prompt
Unarchive survey response
Unarchive survey response
POSTHOG_UNARCHIVE_SURVEY_RESPONSETool 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
Output
Create Experiment Unfreeze Exposure
Create Experiment Unfreeze Exposure
Unpause Batch Export
Unpause Batch Export
POSTHOG_UNPAUSE_BATCH_EXPORTTool 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
Output
Unpause Organization Batch Export
Unpause Organization Batch Export
Update alert (full replacement)
Update alert (full replacement)
POSTHOG_UPDATE_ALERTTool 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
Output
Update annotation details
Update annotation details
POSTHOG_UPDATE_ANNOTATION_DETAILSUpdate an existing annotation in a PostHog project by ID, including its content, date, scope, and deletion status.Input Parameters
dashboard_item- insight *dashboard- dashboard *project- project *organization- organization
Output
Update batch export
Update batch export
Update Cohort Remove Person From Static Cohort
Update Cohort Remove Person From Static Cohort
Update Customer Profile Config
Update Customer Profile Config
POSTHOG_UPDATE_CUSTOMER_PROFILE_CONFIGUpdate 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
Output
Create Dashboard Update Text Tile
Create Dashboard Update Text Tile
POSTHOG_UPDATE_DASHBOARD_TEXT_TILEUpdate text tile in a PostHog project. Update the markdown body, layout, or color of an existing text tile on a dashboard.Input Parameters
Output
Update Dashboard Widgets Batch Update
Update Dashboard Widgets Batch Update
POSTHOG_UPDATE_DASHBOARD_WIDGETSBatch update widgets in a PostHog project. Update the settings of existing widgets in place, atomically — config, name, and description.Input Parameters
Output
Update Datasets
Update Datasets
Update Dataset Items
Update Dataset Items
POSTHOG_UPDATE_DATASET_ITEMSTool 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
Output
Update Desktop Recording
Update Desktop Recording
Update early access project feature
Update early access project feature
POSTHOG_UPDATE_EARLY_ACCESS_PROJECT_FEATUREThis 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
draft- draft *concept- concept *alpha- alpha *beta- beta *general-availability- general availability *archived- archived
Output
Update endpoint
Update endpoint
POSTHOG_UPDATE_ENDPOINTUpdate an existing endpoint configuration in a PostHog project. Provide the project ID and endpoint name, optional configuration values, and optionally a version to target.Input Parameters
Output
Update error tracking autocapture controls
Update error tracking autocapture controls
POSTHOG_UPDATE_ERROR_TRACKING_AUTOCAPTURE_CONTROLTool 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
Output
Update error tracking issue
Update error tracking issue
Update evaluation
Update evaluation
POSTHOG_UPDATE_EVALUATIONTool 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
Output
Update event definition by uuid
Update event definition by uuid
POSTHOG_UPDATE_EVENT_DEFINITIONUpdate 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
Output
Update experiment details
Update experiment details
POSTHOG_UPDATE_EXPERIMENTUpdate 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
Output
Update experiment holdout
Update experiment holdout
POSTHOG_UPDATE_EXPERIMENT_HOLDOUTTool 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
Output
Update experiment holdout (full)
Update experiment holdout (full)
POSTHOG_UPDATE_EXPERIMENT_HOLDOUT_COMPLETETool 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
Output
Update experiment saved metrics
Update experiment saved metrics
POSTHOG_UPDATE_EXPERIMENT_SAVED_METRICUpdate an existing experiment saved metric by project and metric ID. The update requires its name and query, and can also include a description and tags.Input Parameters
Output
Update external data schema
Update external data schema
POSTHOG_UPDATE_EXTERNAL_DATA_SCHEMAPartially update an external data schema’s sync configuration.Input Parameters
Output
Update External Data Sources
Update External Data Sources
POSTHOG_UPDATE_EXTERNAL_DATA_SOURCEUpdate an existing external data source’s credentials, description, or configuration in PostHog. Requires the project ID, data source UUID, account ID, and client secret.Input Parameters
Output
Update feature flag configuration
Update feature flag configuration
Update file system
Update file system
POSTHOG_UPDATE_FILE_SYSTEMUpdate a PostHog file system resource by UUID and project ID using PUT, including its path, type, depth, or metadata. Omitted depth and last-viewed time are sent as null.Input Parameters
Output
Create Group Update Property
Create Group Update Property
Update group type metric
Update group type metric
POSTHOG_UPDATE_GROUPS_TYPES_METRICUpdate a specific group usage metric within a project and group type using a full PUT request. Supply its name and filters, with optional display format and calculation interval.Input Parameters
Output
Update hog function
Update hog function
POSTHOG_UPDATE_HOG_FUNCTIONTool 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
Output
Update Insight Variable
Update Insight Variable
POSTHOG_UPDATE_INSIGHT_VARIABLEUpdate an insight variable in a project by UUID using a PUT request. Provide its name, code name and type, with optional default value, values and creator metadata.Input Parameters
Output
Update live debugger breakpoint
Update live debugger breakpoint
POSTHOG_UPDATE_LIVE_DEBUGGER_BREAKPOINTTool 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
Output
Update LLM Prompt
Update LLM Prompt
POSTHOG_UPDATE_LLM_PROMPTPublish a new version of an existing PostHog LLM prompt by name. Supply a full prompt or sequential text edits, optionally with config and a version note. Use base_version to detect concurrent changes. This does not create a new named prompt or move version labels.Input Parameters
Output
Create Notebook Collab Presence
Create Notebook Collab Presence
POSTHOG_UPDATE_NOTEBOOK_COLLABORATION_PRESENCEUpdate collaboration presence in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.Input Parameters
Output
Update organization details by uuid
Update organization details by uuid
Update organization batch export
Update organization batch export
POSTHOG_UPDATE_ORGANIZATION_BATCH_EXPORTTool 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
Output
Modify org info via uuid
Modify org info via uuid
Update organization domain info and saml config
Update organization domain info and saml config
POSTHOG_UPDATE_ORGANIZATION_DOMAINUpdate 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 rotationInput Parameters
Output
Update organization member by uuids
Update organization member by uuids
POSTHOG_UPDATE_ORGANIZATION_MEMBERUpdate 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
Output
Update organization member details
Update organization member details
Update organization proxy record
Update organization proxy record
POSTHOG_UPDATE_ORGANIZATION_PROXY_RECORDUpdate 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
Output
Update role details in organization
Update role details in organization
Update persisted folder
Update persisted folder
POSTHOG_UPDATE_PERSISTED_FOLDERTool to update an existing persisted folder in PostHog. Use when you need to modify folder properties like path, protocol, or type.Input Parameters
Output
Update person properties
Update person properties
POSTHOG_UPDATE_PERSON_PROPERTIESRequest 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
Output
Update person property endpoint
Update person property endpoint
Update product tour
Update product tour
POSTHOG_UPDATE_PRODUCT_TOURUpdate an existing PostHog product tour using PUT, including its name, description, targeting, content, and schedule. Requires the project ID, tour UUID, and tour name.Input Parameters
Output
Update project action by id
Update project action by id
POSTHOG_UPDATE_PROJECT_ACTIONPUT 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
Output
Update project batch export
Update project batch export
POSTHOG_UPDATE_PROJECT_BATCH_EXPORTUpdate a project’s batch export configuration using PUT. Requires the export’s name, destination, interval, and pause status, with optional settings such as model, schedule, query, and filters.Input Parameters
Output
Update project cohort details
Update project cohort details
POSTHOG_UPDATE_PROJECT_COHORTUpdate 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
Output
Update project dashboard details
Update project dashboard details
POSTHOG_UPDATE_PROJECT_DASHBOARDEndpoint 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
Output
Update project early access feature
Update project early access feature
POSTHOG_UPDATE_PROJECT_EARLY_ACCESS_FEATUREUpdate 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
draft- draft *concept- concept *alpha- alpha *beta- beta *general-availability- general availability *archived- archived
Output
Update project event definition
Update project event definition
POSTHOG_UPDATE_PROJECT_EVENT_DEFINITIONUpdate an event definition in a specified project by UUID, including its name, Slack posting setting, or tags. Requires event definition write permissions; the response is modeled as event definition details.Input Parameters
Output
Update project group type metadata
Update project group type metadata
POSTHOG_UPDATE_PROJECT_GROUP_TYPEPATCH /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
Output
Update project insight details
Update project insight details
POSTHOG_UPDATE_PROJECT_INSIGHTEndpoint “/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
Output
Update project member s role by uuid
Update project member s role by uuid
POSTHOG_UPDATE_PROJECT_MEMBERUpdate 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
Output
Update project notebook details
Update project notebook details
POSTHOG_UPDATE_PROJECT_NOTEBOOKUpdate a project notebook by its short ID, including its title, content, version, or deleted status. The notebook API is in early access and may have breaking changes without announcement.Input Parameters
Output
Update project property definition
Update project property definition
POSTHOG_UPDATE_PROJECT_PROPERTY_DEFINITIONUpdate a project property definition by its UUID, with a name and optional property type and tags. Requires a project ID and definition ID, and personal API key write access; returns property definition details.Input Parameters
Output
Update project session recording playlist
Update project session recording playlist
POSTHOG_UPDATE_PROJECT_SESSION_RECORDING_PLAYLISTUpdate 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
Output
Update project settings
Update project settings
Update project subscription details
Update project subscription details
POSTHOG_UPDATE_PROJECT_SUBSCRIPTIONUpdate 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
daily- Daily *weekly- Weekly *monthly- Monthly *yearly- Yearly
Output
Update project survey details
Update project survey details
POSTHOG_UPDATE_PROJECT_SURVEYThe /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
popover- popover *widget- widget *button- button *email- email *full_screen- full screen *api- api
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 } Output
Update user home settings
Update user home settings
POSTHOG_UPDATE_USER_HOME_SETTINGSTool 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
Output
Update warehouse saved query
Update warehouse saved query
POSTHOG_UPDATE_WAREHOUSE_SAVED_QUERYUpdate 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
Output
Update web experiment
Update web experiment
POSTHOG_UPDATE_WEB_EXPERIMENTTool 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
Output
Update Workflow Actions Email
Update Workflow Actions Email
POSTHOG_UPDATE_WORKFLOW_ACTIONS_EMAILUpdate workflow email action in a PostHog project.Input Parameters
Output
Validate LLM Provider API Key
Validate LLM Provider API Key
POSTHOG_VALIDATE_LLM_PROVIDER_KEYTool 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
Output
Get current user (whoami)
Get current user (whoami)
POSTHOG_WHOAMIDEPRECATED: 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
Triggers
Action Performed
Action Performed
POSTHOG_ACTION_PERFORMEDType: webhookTriggers when an event matches one of the saved PostHog Actions you configure. Use this instead of Event Captured when the behaviour you care about spans several event names or element matches, and you want PostHog’s Action definition to stay the single place it is described. Deliveries count toward your PostHog data pipelines usage, so it pays to watch just the Actions you act on.Configuration
Payload
Activity Log Entry Created
Activity Log Entry Created
POSTHOG_ACTIVITY_LOG_ENTRY_CREATEDType: webhookTriggers when PostHog records an activity-log entry for the project — any audited change to a feature flag, insight, dashboard, destination, experiment or survey. This is the whole audit stream, so it is high volume; branch on scope and activity for the changes you care about.Configuration
Payload
Early Access Feature Updated
Early Access Feature Updated
POSTHOG_EARLY_ACCESS_FEATURE_UPDATEDType: webhookTriggers when an early-access feature changes — most usefully when it moves between stages, such as concept to beta to general availability. The payload carries the whole feature both before and after, so compare previous with next to see what moved.Configuration
Payload
Error Tracking Issue Assigned
Error Tracking Issue Assigned
POSTHOG_ERROR_TRACKING_ISSUE_ASSIGNEDType: webhookTriggers when an error-tracking issue is assigned to a user, a group or a role. Reassigning an already-assigned issue fires it again; clearing an assignee fires Error Tracking Issue Unassigned instead.Configuration
Payload
Error Tracking Issue Created
Error Tracking Issue Created
POSTHOG_ERROR_TRACKING_ISSUE_CREATEDType: webhookTriggers when PostHog groups an exception into an error-tracking issue it has never seen before. Fires once per issue, on the first occurrence — later occurrences of the same fingerprint do not fire it.Configuration
Payload
Error Tracking Issues Merged
Error Tracking Issues Merged
POSTHOG_ERROR_TRACKING_ISSUES_MERGEDType: webhookTriggers when two or more error-tracking issues are merged into one. The payload is the surviving issue; merged_issue_ids names the ones that were absorbed, so anything you track against those ids should be repointed.Configuration
Payload
Error Tracking Issue Split
Error Tracking Issue Split
POSTHOG_ERROR_TRACKING_ISSUE_SPLITType: webhookTriggers when fingerprints are split out of an error-tracking issue into new issues of their own. The payload is the original issue; split_issue_ids names the issues that were created.Configuration
Payload
Error Tracking Issue Status Changed
Error Tracking Issue Status Changed
POSTHOG_ERROR_TRACKING_ISSUE_STATUS_CHANGEDType: webhookTriggers when an error-tracking issue is resolved, reopened or suppressed. One trigger covers all three moves because PostHog sends an identical body for each; branch on previous_status and status to tell them apart.Configuration
Payload
Error Tracking Issue Unassigned
Error Tracking Issue Unassigned
POSTHOG_ERROR_TRACKING_ISSUE_UNASSIGNEDType: webhookTriggers when an error-tracking issue’s assignee is cleared, leaving it unowned. Reassigning to a different person fires Error Tracking Issue Assigned instead, not this.Configuration
Payload
Event Captured
Event Captured
POSTHOG_EVENT_CAPTUREDType: webhookTriggers when PostHog captures one of the analytics events you name. Fires on every matching event, including ones your backend or a third-party integration sent, not only browser events. Deliveries count toward your PostHog data pipelines usage, so it pays to name just the events you act on.Configuration
Payload
Person Updated
Person Updated
POSTHOG_PERSON_UPDATEDType: webhookTriggers when a person’s profile changes in PostHog — a property set, updated or removed, or two people merged into one. Everything the trigger reports is in person: PostHog synthesises the event around the updated profile, so event carries no properties and event.distinct_id holds the person’s id rather than a distinct_id. Every profile change in the project is a delivery and deliveries count toward your PostHog data pipelines usage, which is worth knowing if your project updates people in bulk.