Skip to main content
PostHog logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 690
  • Triggers: 11
  • Slug: POSTHOG
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own PostHog OAuth credentials with Composio, see How to create OAuth credentials for PostHog.
Set the PostHog region on the connection. Use 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

Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ADD_DASHBOARD_WIDGETSBatch dashboard widgets in a PostHog project. Add multiple widget tiles to a dashboard in one atomic request.

Input Parameters

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
array
required
Widget tiles to add atomically. Supported widget_type values: activity_events_list, canvas_app, conversations_recent_tickets, error_tracking_list, experiment_results, experiments_list, logs_list, metrics_table, notebook_widget, session_replay_list, survey_results. Use dashboard-widget-catalog-list for per-type config_schema documentation. (1–10 per request).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ADD_MEMBER_TO_ORGANIZATION_ROLEAdd a member to an organization role by submitting their details and UUID in JSON/form, using organization and role IDs. Requires PersonalAPIKeyAuth. Success gives a 201 status.

Input Parameters

string
required
Role Id (UUID)
string
required
User UUID to add to the role
string
required
Organization Id (UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this cohort.
array
required
List of person UUIDs to add to the static cohort. Each UUID must be a valid person identifier in the project.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this project
string ("product_analytics" | "feature_flags" | "data_warehouse" | "experiments" | "surveys")
required
The product type to add intent for. Indicates which PostHog product feature the project intends to use
string
required
Organization ID (UUID) that owns the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID of the desktop recording to append segments to
array
required
List of transcript segments to append (minimum 1 segment required). Supports batched real-time streaming.
string
required
Project ID (environment ID) containing the recording. Find it via /api/projects/

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ARCHIVE_DATASETArchive dataset in a PostHog project. Archive a dataset. Archived datasets remain readable and reject item mutations.

Input Parameters

string
required
A UUID string identifying this dataset.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ARCHIVE_DATASET_ITEMArchive dataset item in a PostHog project. Archive an active item by creating a new immutable version.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Current item version observed by the caller.
string
required
Dataset item id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ARCHIVE_EXPERIMENTArchive experiment in a PostHog project. Archive an ended experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
When the linked feature flag is still enabled, also disable and archive it along with the experiment. Has no effect if the flag is already disabled (it is archived either way).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ARCHIVE_FEATURE_FLAGArchive feature flag in a PostHog project. Archive a feature flag, hiding it from the default flag list.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ARCHIVE_LLM_PROMPTArchive named LLM prompt in a PostHog project.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Prompt name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
UUID string identifying the survey response to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Role Id (UUID format)
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Feature Flag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Reusable widget to place in this notebook node.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Version to pin, or null to follow the reusable widget’s latest version.
object
Notebook-local input mappings keyed by contract slot. Each value names a source dataframe and may include pure Hog source for reshaping its rows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_BULK_CREATE_ORGANIZATION_INVITESBulk-create PostHog organization invites with configurable access levels, messages, and private project access settings. Up to 20 invites can be sent per bulk request.

Input Parameters

array
required
List of invites to create
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Dashboard IDs to soft-delete. At most 100 IDs per request.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Also delete insights that have no remaining dashboard after deletion. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Insight IDs to soft-delete (or restore). At most 1000 ids per request. Soft-deleted insights can be brought back via the bulk_restore endpoint.
string ("csv" | "json")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Insight IDs to soft-delete (or restore). At most 1000 ids per request. Soft-deleted insights can be brought back via the bulk_restore endpoint.
string ("csv" | "json")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
Format.
boolean
required
Whether every existing insight should filter out internal and test users.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_BULK_UPDATE_TAGS_EXPERIMENTSBulk update experiment tags in a PostHog project. Bulk update tags on multiple objects.

Input Parameters

array
required
List of object IDs to update tags on.
array
required
Tag names to add, remove, or set (up to 100 per request, 255 characters each).
string ("add" | "remove" | "set")
required
‘add’ merges with existing tags, ‘remove’ deletes specific tags, ‘set’ replaces all tags. * add - add * remove - remove * set - set
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_BULK_UPDATE_TAGS_FEATURE_FLAGSBulk update feature flag tags in a PostHog project. Bulk update tags on multiple objects.

Input Parameters

array
required
List of object IDs to update tags on.
array
required
Tag names to add, remove, or set (up to 100 per request, 255 characters each).
string ("add" | "remove" | "set")
required
‘add’ merges with existing tags, ‘remove’ deletes specific tags, ‘set’ replaces all tags. * add - add * remove - remove * set - set
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Pre-computed variance per user. Provide this or baseline_stats when metric_type is ratio/retention and baseline_value is given directly. When given, it replaces the variance the calculator derives for any metric type, including p(1-p) for funnels.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string ("funnel" | "mean_count" | "mean_sum_or_avg" | "ratio" | "retention")
required
Metric type to size for. ‘funnel’ for conversion rates, ‘mean_count’ for event counts per user, ‘mean_sum_or_avg’ for summed property values per user, ‘ratio’ and ‘retention’ for ratio-style metrics (both require baseline_stats or an explicit variance). * funnel - funnel * mean_count - mean_count * mean_sum_or_avg - mean_sum_or_avg * ratio - ratio * retention - retention
object
Raw control-group statistics. When provided, the server derives baseline_value and variance.
number
Baseline metric value: conversion rate as a fraction 0-1 (funnel), average per user (mean), or the ratio (ratio/retention). Provide this or baseline_stats.
integer
Total number of variants including control (default 2, at most 100).
number
Expected exposures per day. When provided, the response includes the recommended running time.
number
required
Smallest relative change to detect, as a percentage (e.g. 5 means a 5% lift). Must be > 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CANCEL_NOTEBOOK_WIDGETCancel a notebook widget generation job in a PostHog project. The notebook API is early access and subject to breaking changes.

Input Parameters

string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Generation job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Insight ID
string
Name
array
Tags
string
Hogql
integer
Order
string
Query node JSON string
boolean
Saved
string
Types
string ("csv" | "json")
Response format (json or csv)
string
Result
string
Columns
boolean
Deleted
string
Filters
string
Short Id of the insight
string
The timezone this chart is displayed in.
boolean
Favorited
string
Is Cached
boolean
Is Sample
string
Created At
array
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
string
required
Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/.
string
Updated At
string
Description
string
Derived Name
string
The datetime this insight results were generated. If added to one or more dashboards the insight can be refreshed separately on each.
string
Query Status
string
The client query ID of the running query to cancel
array
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
string
The target age of the cached results for this insight.
string
Last Modified At
string
The earliest possible datetime at which the cached results for this insight can be refreshed by querying the database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("quick" | "full")
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 query
object
required
The insight query to check, in the shape an insight stores it: an InsightVizNode with its source. Pass the query of a saved insight, or one that is not saved yet.
string ("csv" | "json")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
An id for this run, chosen by the client. To stop the queries of the run, send a DELETE request to query/{client_query_id}/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Pipeline destination plugin ID to check for updates (obtained from list pipeline destinations)
string
required
Organization ID (UUID format) that owns or has access to the pipeline destination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this team (soon to be environment).
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The full source of the cell being edited.
string
required
Short id.
integer
required
Character offset of the cursor in code, counting from 0.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short id.
number
CPU cores for the notebook’s sandbox kernel; must be a supported option.
number
Memory in GB for the notebook’s sandbox kernel; must be a supported option.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
Maximum lifetime of the sandbox kernel in seconds. It shuts down this long after it starts, even while in use. A running kernel keeps its current lifetime until it restarts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_COPY_DASHBOARD_TILECopy dashboard tile in a PostHog project. Copy an existing dashboard tile to another dashboard (insight, text card, or widget tile).

Input Parameters

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
integer
required
Dashboard tile id to copy.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Dashboard id the tile currently belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
Optional name for the copied experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
The team ID to copy the experiment to.
string
Optional feature flag key to use in the destination team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_ACCOUNT_NOTEBOOKCreate account notebook in a PostHog project.

Input Parameters

string
Human-readable title of the account notebook.
string
Notebook content as a ProseMirror JSON document. On create, the server stores it as a markdown notebook.
string
required
UUID of the parent account.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Plain text representation of the notebook content for search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of event objects to capture. Each event must include ‘event’ name and ‘properties’ dict with ‘distinct_id’. Total payload should be under 20MB.
string
required
Project API Key (write-only ingestion key). This is different from your personal API key and is safe to use in public contexts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The end of the data interval for the backfill. Must be in ISO 8601 format (e.g., ‘2026-02-16T10:00:00Z’) and cannot be in the future.
string
required
The start of the data interval for the backfill. Must be in ISO 8601 format (e.g., ‘2026-02-16T09:00:00Z’) and within valid data range.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The BatchExport this backfill belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional password label, up to 100 characters.
string
required
Project ID containing the dashboard.
integer
required
Dashboard ID.
string
Password to create (at least 8 characters after trimming). Omit or pass an empty string to generate a random password. Use a sharing password, not an account password.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_DASHBOARD_TEXT_TILEAdd a Markdown text or image tile to a dashboard in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this dashboard.
string
required
Markdown body for the dashboard tile. Text tiles support headings, lists, and inline formatting. Image tiles require exactly one Markdown image. Max 4000 characters.
string ("text" | "image")
Tile type. Use image for a body with exactly one Markdown image. Defaults to text. * text - text * image - image
string
Optional accent color name (e.g. ‘blue’, ‘green’, ‘purple’, ‘black’).
string ("json" | "txt")
Format.
object
Optional grid layout per breakpoint. If omitted, the tile is placed at the bottom of the dashboard using the default size. Text tiles typically use a thin full-width banner (e.g. w=12, h=1). Object fields: {“sm”: {“type”: “object”, “description”: “Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.”}, “xs”: {“type”: “object”, “description”: “Layout for the small (mobile) breakpoint. The grid is 1 column wide.”}}
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Optional context that helps AI agents make consistent dashboard updates, such as Data Catalog metric names, data sources, tile-specific query assumptions, caveats, or editing guidance. PostHog’s Data Catalog is the semantic layer. Store canonical metric definitions there, not in this field. An empty string or null means there is no agent context. Shared and exported dashboards, and organizations without AI data processing approval, omit this field. Max 10000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the data color theme (max 100 characters)
array
required
List of hex color codes for the theme (e.g., [‘#FF5733’, ‘#33FF57’, ‘#3357FF’])
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Dataset name (required, max 400 characters)
object
Additional metadata for the dataset (optional)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Dataset description (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_DATASET_EXPORTSExport dataset in a PostHog project. Create an asynchronous JSONL export pinned to an immutable dataset revision.

Input Parameters

string
required
A UUID string identifying this dataset.
integer
Dataset revision to export. Defaults to the latest revision when the export is created.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Input data for the dataset item (e.g., prompt or question)
object
Output data for the dataset item (e.g., response or result)
string
required
UUID of the dataset to add this item to
object
Optional metadata associated with the dataset item
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Reference trace ID (max 255 characters)
string
Reference source ID (max 255 characters)
string
Reference timestamp (ISO 8601 datetime format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_DATASET_ITEM_RESTORERestore dataset item in a PostHog project. Restore an archived item by copying content into a new immutable version.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Current item version observed by the caller.
integer
Historical version to copy. Omit to restore the archived version’s content.
string
required
Dataset item id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_DATASET_RESTORERestore dataset in a PostHog project. Restore an archived dataset without changing its item states.

Input Parameters

string
required
A UUID string identifying this dataset.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("zoom" | "teams" | "meet" | "desktop_audio" | "slack")
Meeting platform being recorded (zoom, teams, meet, desktop_audio, or slack)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Error tracking issue ID.
object
Date range for issue impact and latest-event metadata. Defaults to the last 7 days. Object fields: {“date_from”: {“type”: “string”, “description”: “Start of the date range as an ISO timestamp or relative date such as -7d. Defaults to -7d.”}, “date_to”: {“type”: [“string”, “null”], “description”: “End of the date range as an ISO timestamp or relative date. Defaults to now when omitted.”}}
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Set true to include the issue page breakdowns: the most common paths (or URLs when events have no path), screens, browsers, OS, libraries, library versions, and app versions, each with a count, plus the sessions with the most events. Covers at most the last 30 days of dateRange. Adds one aggregate query, so request it only to answer where, for whom, or on which platforms the issue happens. Defaults to false.
boolean
Set true to include a compact numeric occurrence sparkline. Defaults to false.
integer
Integer count of equal-width time buckets across dateRange, from 0 to 200. Not a time unit: ‘hour’, ‘day’, and ‘week’ are invalid. Example: 7 with a 7-day dateRange gives daily buckets. Defaults to 0, or to 12 when includeSparkline is true.
boolean
When true, exclude internal/test account data from results. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page size.
integer
Pagination offset.
array
Context groups to return. Defaults to exception, environment, navigation, and correlation. Request stacktrace for frames, code_variables for captured and SDK-masked frame variables, release for release metadata, or diagnostics for ingestion errors. code_variables implies stacktrace.
string
required
Error tracking issue ID.
object
Date range for sampled exception events. Defaults to the last 7 days. Object fields: {“date_from”: {“type”: “string”, “description”: “Start of the date range as an ISO timestamp or relative date such as -7d. Defaults to -7d.”}, “date_to”: {“type”: [“string”, “null”], “description”: “End of the date range as an ISO timestamp or relative date. Defaults to now when omitted.”}}
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Advanced flat AND property filters applied to sampled events. HogQL filters are rejected.
string
Search exception types, exception values, and current URL among sampled events.
boolean
When true, include only stack frames marked in_app. Defaults to true.
string ("ASC" | "DESC")
Timestamp sort direction. Defaults to DESC. * ASC - ASC * DESC - DESC
boolean
When true, exclude internal/test account data from results. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter by current URL substring.
string
Search user/email text.
integer
Page size. Defaults to 10. Use nextOffset to fetch more rows instead of a large page.
integer
Pagination offset.
string ("archived" | "active" | "resolved" | "pending_release" | "suppressed" | "all")
Filter by issue status. Defaults to active. * archived - archived * active - active * resolved - resolved * pending_release - pending_release * suppressed - suppressed * all - all
string
Filter by SDK/library value from event $lib, for example posthog-js.
string
Filter by exact release ID, version, or git commit ID captured in $exception_release.
object
Filter by issue assignee. Omit to include all assignees.
string ("last_seen" | "first_seen" | "occurrences" | "users" | "sessions" | "severity")
Field used to sort issues. Defaults to occurrences. * last_seen - last_seen * first_seen - first_seen * occurrences - occurrences * users - users * sessions - sessions * severity - severity
string
Search stack-frame source/file path text.
string
Filter by exact PostHog person UUID.
object
Date range for issue aggregates. Defaults to the last 7 days. Object fields: {“date_from”: {“type”: “string”, “description”: “Start of the date range as an ISO timestamp or relative date such as -7d. Defaults to -7d.”}, “date_to”: {“type”: [“string”, “null”], “description”: “End of the date range as an ISO timestamp or relative date. Defaults to now when omitted.”}}
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Filter by exact exception fingerprint hash, not fuzzy search.
array
Advanced flat AND property filters. Prefer typed shortcut fields when they fit. HogQL filters are rejected.
string
Free-text search across exception types, values, stack frames, and email fields.
string ("ASC" | "DESC")
Sort direction. Defaults to DESC. * ASC - ASC * DESC - DESC
string
Only include issues first seen strictly after this ISO timestamp or relative date, such as -24h or -7d. Independent of dateRange, which filters occurrences.
integer
Integer count of equal-width time buckets across dateRange, from 0 to 200. Not a time unit: ‘hour’, ‘day’, and ‘week’ are invalid. Example: 7 with a 7-day dateRange gives daily buckets. Defaults to 0, which returns only aggregate counts without volume buckets.
boolean
When true, exclude internal/test account data from results. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID string identifying this error tracking release
string
required
Hash identifier for the release (e.g., ‘release-hash-abc123’)
string
required
Project name or identifier this release belongs to
integer
required
Team ID associated with this release
string
required
Version string of the release (e.g., ‘1.0.0’, ‘v2.3.1-beta’)
object
Additional metadata associated with the release (optional)
string
required
ISO 8601 timestamp when the release was created (e.g., ‘2026-02-16T10:00:00Z’)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the evaluation (max 400 characters)
boolean
Whether the evaluation is marked as deleted. Generally not needed when creating.
boolean
Whether the evaluation is enabled. Defaults to true if not specified.
object
Conditions configuration for when the evaluation should run
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Optional description of what this evaluation does
string ("boolean")
required
Output type of the evaluation. Currently supported: ‘boolean’ (Boolean Pass/Fail)
object
Output configuration settings for how results are formatted
string ("llm_judge")
required
Type of evaluation. Currently supported: ‘llm_judge’ (LLM as a judge)
object
Configuration settings for the evaluation logic
object
Model configuration for the evaluation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The event name/type as a simple string
string
required
ISO 8601 timestamp for the evaluation run
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The UUID of the evaluation to run
string
required
The UUID of the target event to evaluate (must be an existing event in PostHog)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_EXPERIMENT_EXPOSURE_COHORTCreate an exposure cohort for an experiment in a project using the experiment ID and project ID.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Experiment name. Omit or pass blank to generate from prompt, versions and templates.
array
required
Ordered list of 2-10 distinct existing prompt versions. The first version is control.
array
required
Distinct primary metric templates, each scoped to this prompt’s $ai_prompt_name.
string
required
PostHog project ID containing the prompt.
string
Optional experiment description; may be blank, but not null.
string
required
Name of an existing, unarchived LLM prompt in this project.
string
NEW feature flag key; existing keys are rejected. Omit or pass blank to generate a collision-free slug from the experiment name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the experiment holdout (max 400 characters).
array
required
List of filter configurations for the holdout. At least one filter with properties and rollout_percentage is required.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the experiment holdout (max 400 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the experiment saved metric (max 400 characters)
array
List of tags associated with the saved metric
object
required
Query configuration for the saved metric. Must include ‘kind’ field (e.g., ‘ExperimentTrendsQuery’ or ‘ExperimentFunnelsQuery’) and a nested ‘count_query’ with the actual query structure.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the experiment saved metric (max 400 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_FEATURE_FLAG_COHORTCreate a static cohort for a specific feature flag in a project.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
Key
string
contains the description for the flag (field name name is kept for backwards-compatibility)
array
Tags
boolean
Active
boolean
Deleted
object
Filters
object
Surveys
boolean
Can Edit
object
Features
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Experiment Set
boolean
Is Simple Flag
integer
Usage Dashboard
boolean
Performed Rollback
integer
Rollout Percentage
string
Rollback Conditions
array
Analytics Dashboards
boolean
Has Enriched Analytics
boolean
Ensure Experience Continuity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_CREATE_FEATURE_FLAG_DASHBOARDCreate a dashboard for a specific feature flag in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
Key
string
contains the description for the flag (field name name is kept for backwards-compatibility)
array
Tags
boolean
Active
boolean
Deleted
object
Filters
object
Surveys
boolean
Can Edit
object
Features
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Experiment Set
boolean
Is Simple Flag
integer
Usage Dashboard
boolean
Performed Rollback
integer
Rollout Percentage
string
Rollback Conditions
array
Analytics Dashboards
boolean
Has Enriched Analytics
boolean
Ensure Experience Continuity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID identifier for the file system resource
string
Reference identifier for the file system (max 100 characters)
string
URL reference to the file system resource
object
Additional metadata associated with the file system
string
required
Path of the file system resource
string
required
Type of the file system resource (max 100 characters)
integer
Depth level of the file system resource in the hierarchy
boolean
Whether this file system is a shortcut
string
required
ISO 8601 timestamp of when the file system was created
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
ISO 8601 timestamp of when the file system was last viewed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique key for the new group within its group type.
string
required
Project ID. Discover projects with GET /api/projects/.
string
Group properties. Send a JSON object of property names to values; omission defaults to an empty object on the provider.
integer
required
Existing group type index, discovered with GET /api/projects/{project_id}/groups_types/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional password label, up to 100 characters.
integer
required
Insight ID.
string
required
Project ID containing the insight.
string
Password to create (at least 8 characters after trimming). Omit or pass an empty string to generate a random password. Use a sharing password, not an account password.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique prompt name using letters, numbers, hyphens, and underscores only.
object
Optional JSON object with model parameters or agent configuration, versioned with the prompt. Do not store secrets: anyone who can read the prompt can read config.
string
required
Prompt payload as JSON or string data.
string
required
Project ID. Find projects with GET /api/projects/.
string
Optional note describing what changed in this version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Query object containing the HogQL query specification for exporting logs
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional password label, up to 100 characters.
string
required
Project ID containing the notebook.
string
required
Notebook ID.
string
Password to create (at least 8 characters after trimming). Omit or pass an empty string to generate a random password. Use a sharing password, not an account password.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Notebook widget node to add to a dashboard.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Immutable widget version to keep on the dashboard.
string
Completed whole-notebook run supplying every input after refresh.
string
Snapshot being refreshed; its version and input mappings must match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Title for a new dashboard widget.
string
required
Notebook widget node to add to a dashboard.
integer
Existing dashboard tile to refresh.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Immutable widget version to keep on the dashboard.
integer
Dashboard to add the widget to.
string
Completed whole-notebook run supplying every input after refresh.
string
Snapshot being refreshed; its version and input mappings must match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The display name for the new role (e.g., ‘Feature Flag Manager’, ‘Analytics Reviewer’)
string
required
The unique identifier (UUID) of the organization where the role will be created
integer
Optional integer representing the permission level for feature flag operations. Higher values typically grant more permissions. If not specified, the role will be created without specific feature flag access restrictions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID identifier for the persisted folder
string
Path of the persisted folder
string ("home" | "pinned" | "custom_products")
required
Type of the persisted folder: ‘home’ (Home), ‘pinned’ (Pinned), or ‘custom_products’ (Custom Products)
string
Protocol used for the persisted folder (maximum 64 characters)
string
required
ISO 8601 datetime when the persisted folder was created
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
ISO 8601 datetime when the persisted folder was last updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Id
string
required
Name
string
required
Uuid
string ("csv" | "json")
Format
string
required
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Properties
array
required
Distinct Ids

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Id (read-only, server-generated)
string
Name
array
Tags
array
Steps
string ("csv" | "json")
Format
boolean
Deleted
integer
Team Id (read-only, server-generated)
boolean
Is Action
string
Created At (read-only, server-generated)
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
boolean
Post To Slack
string
Bytecode Error (read-only, server-generated)
boolean
Is Calculating (read-only, server-generated)
string
Last Calculated At
string
Slack Message Format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the cohort (required)
string
Query
string
Groups - defines cohort criteria for dynamic cohorts
boolean
Deleted
string
Filters
boolean
Is Static - set to true for static cohorts
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the experiment
string
Filters
boolean
Archived
string
End Date
string
Parameters
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Start Date
string
Description
string
required
Feature Flag Key for the experiment
string
Secondary Metrics

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Title of the notebook
string
Content of the notebook as a JSON document structure
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Plain text content of the notebook

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this plugin config.
object
Job payload schema for plugin jobs
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Count
string
Title
boolean
Deleted
integer
Insight
integer
Bysetpos
integer
Interval
array
Byweekday
integer
Dashboard
string ("daily" | "weekly" | "monthly" | "yearly")
required
  • daily - Daily * weekly - Weekly * monthly - Monthly * yearly - Yearly
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Start Date
string
Until Date
string ("email" | "slack" | "webhook")
required
  • email - Email * slack - Slack * webhook - Webhook
string
required
Target Value
string
Invite Message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this session recording.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name for the warehouse saved query. Must contain only letters, numbers, underscores (_), dots (.), or dollar signs ($). Maximum length is 128 characters.
object
required
HogQL query object containing the query kind and query string to execute
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique identifier for the web experiment
string
required
Human-readable name for the web experiment (max 400 characters)
object
required
Dictionary mapping variant names to their configurations. Common variant names include ‘control’, ‘test’, ‘variant_a’, ‘variant_b’.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Key of the feature flag that controls this web experiment. The feature flag must exist in the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ACCOUNT_NOTEBOOKDelete account notebook in a PostHog project.

Input Parameters

string
required
Short id.
string
required
UUID of the parent account.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this alert configuration.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this customer profile config.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_DASHBOARD_SHARING_PASSWORDDelete sharing password in a PostHog project. Delete a password from the sharing configuration.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Password id.
integer
required
Dashboard id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_DASHBOARD_TILEDelete dashboard tile in a PostHog project. Soft-delete a single tile from a dashboard.

Input Parameters

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
integer
required
ID of the dashboard tile to delete. Use dashboard-get to look up tile IDs.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this desktop recording.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name for the endpoint
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking auto capture controls.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking grouping rule.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking release.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking suppression rule.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment holdout.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_EXPERIMENT_SAVED_METRICDelete an experiment saved metric by ID from a PostHog project. Returns a success flag and the HTTP status code.

Input Parameters

integer
required
A unique integer value identifying this experiment saved metric.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this feature flag role access.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Feature Flag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this file system.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_GROUP_PROPERTYDelete group property in a PostHog project.

Input Parameters

string
required
Specify the key of the group to find
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Name of the property to delete.
integer
required
Specify the group type to find

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this group usage metric.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Group type index (0-4) identifying which group type to access

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this insight.
string
Response format - either ‘csv’ or ‘json’. Defaults to json if not specified.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_INSIGHT_SHARING_PASSWORDDelete insight sharing password in a PostHog project. Delete a password from the sharing configuration.

Input Parameters

integer
required
Insight id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Password id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this insight variable.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this live debugger breakpoint.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_LLM_PROMPT_LABELSDelete LLM prompt label in a PostHog project.

Input Parameters

string
required
Label name.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Prompt name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Notebook id.
string
required
Password id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATIONDelete an organization by its UUID. Requires a ‘PersonalAPIKeyAuth’ with ‘organization:write’ permission. On success, returns a 204 status code with no response body.

Input Parameters

string
required
A UUID string identifying this organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_BATCH_EXPORTDelete a specific batch export by its UUID in an organization. Requires PersonalAPIKeyAuth with batch_export:write permission. Returns 204 on success with no response body.

Input Parameters

string
required
A UUID string identifying this batch export.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_DOMAINDelete a specific domain by its UUID within an organization, given valid organization and domain IDs. Requires ‘organization:write’ permission; no response body on success (204).

Input Parameters

string
required
A UUID string identifying this domain.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID of the user to remove from the organization. You can get this from listing organization members. Note: This is the user’s UUID, not the membership ID.
string
required
UUID of the organization from which to remove the member. You can get this from the current user profile or by listing organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_PIPELINE_DESTINATIONDelete a specific pipeline destination in an organization by ID. Requires an integer ‘id’ of the destination, and the organization’s ‘uuid’. Auth: PersonalAPIKey with plugin:write. No return body on success (204).

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_PIPELINE_IMPORT_APPDelete a specific pipeline import app plugin associated with an organization by ID. Requires a personal API key with write permissions for plugins. Responds with no content on success (204).

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_PIPELINE_TRANSFORMATIONDelete a specific pipeline transformation plugin for an organization by ID. Requires a UUID for the organization and an integer for the plugin. Auth: PersonalAPIKey with write access. No response body on success (204).

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_PLUGINDelete a specific plugin (by its integer ID) from the organization (identified by UUID) with no response body on success. Requires plugin:write authorization via PersonalAPIKeyAuth.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_PROJECTDelete a specified project from an organization using the organization ID and project ID.

Input Parameters

integer
required
A unique integer value identifying this team (soon to be environment).
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_PROXY_RECORDDelete a proxy record by ID for a specific organization. Requires an authenticated user with ‘organization:write’ permission. On success, it responds with a 204 status and no content.

Input Parameters

string
required
Id
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_ORGANIZATION_ROLEDelete a role with a specific UUID in an organization. Requires ‘organization:write’ permission. No response body on success (204). Path parameters include ‘id’ and ‘organization_id’.

Input Parameters

string
required
A UUID string identifying this role.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this Persisted Folder.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_PERSONDelete a person by UUID in a PostHog project, optionally requesting deletion of their associated events.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A unique UUID value identifying this person.
string ("csv" | "json")
Response format (csv or json)
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
array
required
Array of property keys to delete from the person. Each string in the array represents a property name to remove. Example: [“$geoip_latitude”, “$geoip_longitude”]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this product tour.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this batch export.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
User Uuid
integer
required
Dashboard Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this early access feature.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this event definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
boolean
Set to true to soft-delete the experiment.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this plugin config.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DELETE_PROJECT_QUERYCancel a specific project query by its ID. This operation is experimental.

Input Parameters

string
required
Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this property definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (UUID) of the role membership to remove. Use the list role memberships endpoint to get valid membership IDs for a specific role.
string
required
The unique identifier (UUID) of the role from which to remove the membership. Use the organization roles list endpoint to get valid role IDs.
string
required
The unique identifier (UUID) of the organization containing the role. Use the organization list or details endpoints to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this session recording.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The short identifier (short_id) of the session recording playlist from which to remove the recording. Obtain this from creating or listing session recording playlists.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The unique identifier of the session recording to remove from the playlist. This must be a valid recording ID from an existing session recording in the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this data warehouse saved query.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this web experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DISABLE_FEATURE_FLAGDisable feature flag in a PostHog project. Disable a feature flag.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
integer
The 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.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this cohort.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying the experiment to duplicate.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_DUPLICATE_LLM_PROMPTDuplicate named LLM prompt in a PostHog project.

Input Parameters

string
required
Name for the duplicated prompt. Must be unique and use only letters, numbers, hyphens, and underscores.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Prompt name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying the survey to duplicate.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
required
A non-empty list of team IDs representing the target projects where the survey should be duplicated. All IDs must correspond to teams within the user’s organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ENABLE_FEATURE_FLAGEnable feature flag in a PostHog project. Enable a feature flag.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
integer
The 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.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
required
Name
string ("draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived")
required
  • draft - draft * concept - concept * alpha - alpha * beta - beta * general-availability - general availability * archived - archived
string
required
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
integer
Feature Flag Id
string
Documentation Url

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_END_EXPERIMENTEnd experiment in a PostHog project. End a running experiment without shipping a variant.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string ("won" | "lost" | "inconclusive" | "stopped_early" | "invalid")
The conclusion of the experiment. * won - won * lost - lost * inconclusive - inconclusive * stopped_early - stopped_early * invalid - invalid
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
GitHub repository to open the cleanup pull request in, in organization/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.
boolean
When true, open a draft pull request that removes the experiment’s feature-flag code from the linked repository. A personal API key needs the task:write scope (403 otherwise). Skipped when the conclusion is empty, or when no connected repository can be resolved.
string
Optional comment about the experiment conclusion.
boolean
When true, also save 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier for the symbol set in UUID format
string
required
Reference identifier (e.g., git branch or commit reference)
string
required
Release version identifier for the symbol set
integer
required
Team ID associated with the symbol set (same as project_id in most contexts)
string
Optional ISO 8601 timestamp when the symbol set was last used
string
required
ISO 8601 timestamp when the symbol set was created (e.g., ‘2024-01-01T00:00:00Z’)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Optional storage pointer referencing where the symbol set data is stored
string
Optional reason for failure if the symbol set upload or processing failed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this annotation.
boolean
Set to true to mark the annotation as deleted (soft delete).
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_FORK_NOTEBOOK_WIDGETFork notebook widget in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.

Input Parameters

string
required
Stable identifier of the reusable widget node to fork.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Immutable version to fork, or null to copy the placement’s pinned or latest version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_FREEZE_EXPERIMENT_EXPOSUREFreeze experiment exposure in a PostHog project. Freeze exposure on a running experiment while metrics keep flowing.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name.
array
Tags.
integer
Order.
object
Query.
string ("csv" | "json")
Format.
boolean
Deleted.
boolean
Favorited.
array
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on. This field is omitted from session-authenticated responses unless 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.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description.
string
Derived name.
string
create in folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Query configuration object for the insight. Must include ‘kind’ (e.g., ‘InsightVizNode’) and ‘source’ with query details like TrendsQuery, FunnelsQuery, etc.
string
Response format. Options: ‘json’ (default) or ‘csv’.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("claude-haiku-4-5" | "claude-sonnet-4-6" | "claude-sonnet-5" | "claude-opus-5")
AI model used to generate the widget. * 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-5
string
required
Instructions for the generated widget. Initial and improvement instructions accept up to 20,000 characters; regeneration accepts complete instructions up to 50,000 characters.
string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Idempotency key for this generation job.
string ("initial" | "regenerate" | "improve")
Whether to generate from scratch or improve the current source. * initial - initial * regenerate - regenerate * improve - improve
string
Current widget version the improvement is based on. Required for improve operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GENERATE_SURVEY_TRANSLATIONSGenerate survey translations in a PostHog project.

Input Parameters

string
required
A UUID string identifying this survey.
object
Optional translation-only draft survey payload to translate instead of the last saved survey.
boolean
Whether to overwrite existing translations for this language.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Optional override for the source language code. Defaults to the survey’s base_language (or ‘en’ if unset).
string
required
Language code to generate translations for, for example pt-BR.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ACCOUNT_NOTEBOOKRetrieve account notebook in a PostHog project.

Input Parameters

string
required
Short id.
string
required
UUID of the parent account.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ACTION_REFERENCESList action references in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this action.
string ("csv" | "json")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The plugin configuration ID for which to retrieve app metrics. Plugin configs represent installed apps/plugins in PostHog. To find available plugin config IDs, use the list_project_plugin_configurations action.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Plugin config ID (app metric ID) for which to retrieve error details. This is the unique integer identifier of a plugin configuration. Use the list_project_plugin_configurations action to find valid IDs.
string
required
Project ID of the project containing the plugin config. To find the ID of a project, use the list_all_projects_across_organizations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this batch export.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The pagination cursor value.
string
Which field to use when ordering the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The BatchExport this backfill belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_BILLING_DETAILSRetrieve billing and subscription details for the connected PostHog account. Use this to inspect plan status, totals, discounts, and available product features.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_COHORT_ACTIVITY_DETAILSRetrieve activity log entries for a specific cohort in a project, including activity details and pagination information.

Input Parameters

integer
required
A unique integer value identifying this cohort.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this cohort.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this cohort.
integer
Number of results to return per page.
string ("csv" | "json")
Format
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this cohort.
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_COHORT_USED_INFind cohort usage in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this cohort.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
A UUID string identifying this conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_CURRENT_PERSONAL_API_KEYRetrieve metadata, grants, and resource restrictions for the personal API key authenticating this connection. The normal response excludes credential fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this customer profile config.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
string ("blocking" | "force_blocking" | "force_cache")
Cache behavior. ‘force_cache’ (default) serves from cache even if stale. ‘blocking’ uses cache if fresh, otherwise recalculates. ‘force_blocking’ always recalculates.
string
Comma-separated dashboard tile IDs to run. Defaults to every insight tile on the dashboard. Use it to read one tile without receiving the others. An ID that is not on this dashboard is rejected.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string ("json" | "optimized")
‘optimized’ (default) returns LLM-friendly formatted text per insight, bounded by max_result_chars. ‘json’ returns the raw query result objects, unbounded.
string
Object (or pre-encoded JSON string) to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. Accepts the same keys as the dashboard filters schema (e.g., date_from, date_to, properties). Ignored when accessed via a sharing token.
integer
Per-tile character budget for ‘optimized’ output, truncation marker included. A longer table keeps its header and both ends, and names how many rows were dropped from the middle. Defaults to 2000; pass 0 for the whole table, or 200 or more, since a smaller budget cannot carry the marker. Ignored when output_format is ‘json’. Any value above zero is also held down to what the response has left of its 30000 character budget, and tiles past that budget are not run.
string
Object (or pre-encoded JSON string) to override dashboard variables for this request only (not persisted). Format: {“<variable_id>”: {“code_name”: “<code_name>”, “variableId”: “<variable_id>”, “value”: <new_value>}}. Each entry must include 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_DASHBOARD_RUN_WIDGETSRun dashboard widgets in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
string
required
Comma-separated dashboard tile IDs to run widgets for.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this dashboard template.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this data color theme.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this dataset.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_DATASET_EXPORTSRetrieve dataset export in a PostHog project. Check the status of a dataset export created by the current user.

Input Parameters

string
required
A UUID string identifying this dataset.
string
required
Export ID returned by Create Dataset Exports. Accepts its integer ID or a string representation.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_DATASET_EXPORTS_CONTENTDownload dataset export in a PostHog project. Download a completed dataset JSONL export.

Input Parameters

string
required
A UUID string identifying this dataset.
string
required
Export ID returned by Create Dataset Exports. Accepts its integer ID or a string representation.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this dataset item.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
Filter by dataset ID
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Dataset item id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this dataset.
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
array
Filter datasets by a list of IDs.
integer
The initial index from which to return the results.
Search in name, description, or metadata
array
Ordering. Options: ‘created_at’, ‘-created_at’ (descending), ‘updated_at’, ‘-updated_at’ (descending)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ENDPOINTRetrieve named endpoint in a PostHog project. Retrieve an endpoint, or a specific version via ?version=N.

Input Parameters

string
required
URL-safe name for the endpoint
integer
Endpoint version to act on. Defaults to the current version.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Names.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name for the endpoint
string
Only return entries after this ISO 8601 timestamp. Defaults to 7 days ago; pass an explicit value to read further back.
string
Comma-separated log levels to include, e.g. ‘WARN,ERROR’. Valid levels: DEBUG, LOG, INFO, WARN, ERROR.
integer
Maximum number of log entries to return (1-500, default 50).
string
Only return entries before this ISO 8601 timestamp.
string
Case-insensitive substring search across log messages.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Filter logs to a specific execution instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ENDPOINT_MATERIALIZATION_STATUSGet materialization status in a PostHog project. Get materialization status for an endpoint. Supports ?version=N query param.

Input Parameters

string
required
URL-safe name for the endpoint
integer
Endpoint version to act on. Defaults to the current version.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name for the endpoint
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ENDPOINT_RUNExecute a named PostHog project endpoint via GET and return its query results.

Input Parameters

string
required
URL-safe name for the endpoint
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking auto capture controls.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ERROR_TRACKING_ISSUERetrieve one error tracking issue by ID for a PostHog project. Optionally use a fingerprint to resolve an issue moved by regrouping.

Input Parameters

string
required
UUID of the error tracking issue to retrieve.
string
required
PostHog project ID containing the error tracking issue.
string
Fingerprint used to resolve an issue that may have moved after regrouping.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking release.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The hash identifier of the error tracking release to retrieve.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this evaluation.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Filter by a list of evaluation IDs.
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
Search in name or description
boolean
Filter by enabled status
array
Ordering. Multiple values may be specified for multi-level ordering.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this event definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The exact event name to look up (e.g., ‘$pageview’, ‘$groupidentify’, ‘user_signed_up’)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
integer
Page number
integer
Number of items per page
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_EXPERIMENT_FLAG_CLEANUP_TASKRetrieve flag cleanup task in a PostHog project. Status of the flag-cleanup Desktop task opened for this experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment holdout.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_EXPERIMENT_METRICS_RECALCULATIONRetrieve metric recalculation in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
UUID of the recalculation run to fetch. This is the run’s own id, not the experiment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_EXPERIMENT_METRICS_RECALCULATION_LATESTRetrieve latest metric recalculation in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment saved metric.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
string
Field name to sort results by. Prefix with ’-’ for descending order.
string
Filter by active status. Must be ‘true’ or ‘false’ as a string.
integer
The initial index from which to return the results.
string
Filter by feature flag key or name (case insensitive search).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
Filter feature flags by the ID of the user who created them.
string
Filter by feature flag evaluation runtime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_EXPERIMENT_SESSION_CONTEXTSCreate session contexts in a PostHog project. Resolve experiment context for a batch of session recordings.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
required
IDs of the session recordings to resolve experiment context for, at most 20 per request. Duplicates are ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Event of the candidate primary metric. With target_event, candidate_metric returns a baseline. Without it, candidate_metric returns only the event’s volume. Also marks the shared metrics that count this event.
string
Event that marks a visit to the surface under test, for example ‘$pageview’ or ‘$screen’. Needed for target_surface and for the baseline in candidate_metric.
array
Event or person property filters that narrow the metric event, for the metric that counts only some of its occurrences. At most 10 filters, and each needs type ‘event’ or ‘person’. Needs metric_event.
array
Event or person property filters that narrow the target event, for example an exact $host and $pathname for one page. At most 10 filters, and each needs type ‘event’ or ‘person’. Needs target_event. Combines with target_url_contains.
string
Only counts target events whose $current_url contains this text, ignoring case. Needs target_event to be ‘$pageview’.
integer
How many shared metrics to return, most reused first, 1 to 25.
integer
How many experiments to return, most recently launched first, then drafts, 1 to 25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_EXPERIMENTS_STATSRetrieve experimentation velocity statistics for a PostHog project, including recent launch counts, percentage change, active experiments, and recent completions.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID of the organization to retrieve export unsubscribe configurations for (e.g., ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’). Use POSTHOG_FETCH_ORGANIZATION_DETAILS_BY_UUID or POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID of the organization to retrieve export unsubscribe configurations for (e.g., ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’). Use LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATION or similar actions to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_EXTERNAL_DATA_SCHEMARetrieve one external data schema and its sync configuration.

Input Parameters

string
required
UUID identifying the external data schema.
string
required
PostHog project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this external data source.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
A search term to filter external data sources.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_FEATURE_FLAG_ACTIVITY_DETAILSRetrieve activity details for a specific feature flag in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Feature flag IDs to look up keys for. Strings of digits are also accepted; any other value is reported in the response warning field and otherwise ignored.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_FEATURE_FLAG_REMOTE_CONFIGRetrieve remote configuration in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this feature flag role access.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Feature Flag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_FEATURE_FLAGS_ACTIVITY_LOGRetrieve the feature flag activity log for a PostHog project.

Input Parameters

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_FEATURE_FLAGS_EVALUATION_REASONSRetrieve feature flag evaluation results and reasons for a specified user in a PostHog project.

Input Parameters

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The distinct ID of the user for whom to evaluate feature flags. This is used to determine which feature flags are enabled for the specific user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_FEATURE_FLAG_USER_BLAST_RADIUSCalculate user blast radius in a PostHog project.

Input Parameters

object
required
The release condition to evaluate
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
Group type index for group-based flags (null for person-based flags)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_FEATURE_FLAG_VERSIONSRetrieve feature flag version in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
The version number to reconstruct.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this file system.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this file system shortcut.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("event" | "person" | "group" | "session")
What property definitions to return * event - event * person - person * group - group * session - session
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
Searches properties by name
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Comma-separated list of properties to filter
string
If sent, response value will have is_seen_on_filtered_events populated. JSON-encoded
boolean
Whether to return only (or excluding) numerical property definitions
boolean
Whether to return only (or excluding) feature flag properties
integer
What group type is the property for. Only should be set if type=group
string
JSON-encoded list of excluded properties
boolean
Whether to return only properties for events in event_names

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_GROUP_PROPERTY_VALUESRetrieve group property values for a property key and group type in a PostHog project. The response is a list of strings.

Input Parameters

string
required
Specify the property key to find values for
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Specify the group type to find property values of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this group usage metric
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Numerical identifier for the group type (e.g., 0, 1, 2). Used to differentiate between different types of groups such as companies, projects, or teams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Numerical identifier for the group type (e.g., 0, 1, 2). Used to differentiate between different types of groups such as companies, projects, or teams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Plugin Config Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this hog function.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_HOG_FUNCTION_METRIC_TOTALSRead aggregate execution metric totals for a PostHog Hog function.

Input Parameters

string
required
UUID of the Hog function whose metric totals to retrieve.
string
Filter totals to a metric kind.
string
Filter totals to a metric name.
string
Start of the metrics time range as an ISO 8601 datetime or relative duration such as ‘-7d’.
string
End of the metrics time range as an ISO 8601 datetime or relative duration.
string ("hour" | "day" | "week")
Time interval used to aggregate metrics: hour, day, or week.
string
required
ID of the PostHog project containing the Hog function.
string
Filter metrics to a specific Hog function instance ID.
string ("name" | "kind")
Dimension by which to break down metric totals: name or kind.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter hog functions by ID
array
Filter hog functions by type. Multiple values may be provided as a list
integer
Number of results to return per page
integer
The initial index from which to return the results
string
A search term to filter hog functions
boolean
Filter hog functions by enabled status
string
Filter hog functions by creation date
integer
Filter hog functions by creator user ID
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Filter hog functions by last update date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Numeric project ID (e.g., ‘12345’). Must be an integer ID, not a project name or slug. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Numeric primary key or 8-character short_id (for example AaVQ8Ijw) identifying the insight.
string ("quick" | "full")
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 query
string ("csv" | "json")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Insight Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
integer
required
Unique integer identifier for the insight whose thresholds you want to retrieve.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this threshold.
integer
required
ID of the insight to retrieve threshold for
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this insight variable.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A page number within the paginated result set.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this live debugger breakpoint.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page
integer
The initial index from which to return the results
string
Filter breakpoints by filename
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Filter breakpoints by repository

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
LLM provider name (e.g., openai, anthropic)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Fetch the version pointed to by this label, e.g. production. Labels use lowercase letters, numbers, dots, hyphens and underscores. Mutually exclusive with version.
string ("full" | "preview" | "none")
Content mode (provider default: full). Full includes prompt and config; preview includes the first 160 characters as prompt_preview; none omits content. Outline is always included.
boolean
Resolve @@@prompt:…@@@ references into content (provider default: true). Set false for raw reference tags. Only applies to full content.
integer
Specific prompt version to fetch. Defaults to the latest version when neither version nor label is given.
string
required
PostHog project ID containing the prompt.
string
required
Name of the prompt to retrieve. Cannot contain slashes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of versions to return per page (1-100).
integer
Zero-based offset into version history for pagination. Mutually exclusive with before_version.
integer
Specific prompt version to fetch. If omitted, the latest version is returned.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Exact prompt version UUID to resolve. Can be used together with version for extra safety.
string
required
Prompt name.
integer
Return versions older than this version number. Mutually exclusive with offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this logs alert configuration.
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The log field key to retrieve values for (e.g., ‘level’, ‘message’, ‘source’, ‘timestamp’). This parameter is required.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short id.
integer
Maximum number of complete data events to return. Resume with the returned last_event_id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
number
Maximum streaming window in seconds. Returns earlier on EOF, the event/byte limit, or five seconds without incoming bytes. A blocked read may add at most five seconds to this window.
string
Optional Last-Event-ID header to resume collaboration events after a previous SSE event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the whole-notebook run, as returned by the run endpoint.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Notebook id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the run, as returned by the run dispatch endpoint.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Limit.
integer
Offset.
string
Run id.
string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Allowed dataframe slot requested by the widget.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Version id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Snapshot id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum rows in this page.
integer
Zero-based row offset.
string
Completed run selected by the first page request.
string
required
Short id.
string
required
Frame name.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Version requesting the data.
string
required
Snapshot id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Immutable widget version whose source should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Limit.
integer
Offset.
string
required
Widget node identifier.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ORGANIZATIONRetrieve organization details by UUID. Endpoint requires ‘organization:read’ access. Response includes name, slug, timestamps, membership, plugins access level, and team structure.

Input Parameters

string
required
A UUID string identifying this organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_PERSON_EMAILSList a page of emails for a person in a PostHog project, with pagination parameters for additional pages.

Input Parameters

integer
required
A unique integer value identifying this person.
string
Start of the time range, matched on sent time. Relative (‘-30d’, ‘-24h’) or ISO 8601. Defaults to -30d (the retention window) — bounds the ClickHouse partition scan.
integer
Maximum number of assets to return (1-500, default 50).
string
End of the time range, matched on sent time. Same format as ‘after’. Defaults to now.
string ("csv" | "json")
Format.
integer
Number of assets to skip, for pagination.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this person.
string
Start of the time range, matched on sent time. Relative (‘-30d’, ‘-24h’) or ISO 8601. Defaults to -30d (the retention window) — bounds the ClickHouse partition scan.
integer
Maximum number of assets to return (1-500, default 50).
string
End of the time range, matched on sent time. Same format as ‘after’. Defaults to now.
string ("csv" | "json")
Format.
integer
Number of assets to skip, for pagination.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("json" | "csv")
Response renderer. JSON returns a results map; CSV is returned as raw text in data.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Distinct IDs to look up. Empty or omitted returns an empty results map. PostHog processes only the first 200 IDs; split larger lookups into batches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Person UUIDs to look up. Empty or omitted returns an empty results map. PostHog processes only the first 200 entries and canonicalizes UUIDs; invalid UUIDs in that batch cause an error. Split larger lookups into batches.
string ("csv" | "json")
Response format. JSON returns a results map; CSV returns raw text in data.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique integer ID of the pipeline destination config. Get this from POSTHOG_LIST_PIPELINE_DESTINATION_CONFIGS_WITH_PAGINATION.
string
required
Project ID of the project (integer as string, e.g., ‘302160’). Get this from POSTHOG_LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this product tour.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Cache key returned by a query response (not the query ID). This read does not start an analysis.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_ROLE_MEMBERSHIPRetrieve details of a specific role membership within an organization by its UUID. Use this to view information about a user’s assignment to a particular role, including when they were assigned and their organization member details.

Input Parameters

string
required
A UUID string identifying this role membership
string
required
Role UUID to retrieve membership from
string
required
Organization UUID containing the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this signal report.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_SPIKE_DETECTION_CONFIGURATIONRetrieve the active error tracking spike detection configuration for a project. Use this to inspect the project’s alert snooze duration, multiplier, and threshold.

Input Parameters

string
required
Project ID whose error tracking spike detection configuration should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
integer
Maximum number of rows to return (1-500). Defaults to 100.
string
Only return responses submitted on or after this ISO 8601 timestamp.
string
Only return responses submitted on or before this ISO 8601 timestamp.
integer
Number of rows to skip for pagination. Combine with limit and the has_more field to paginate.
number
Filter to rows where the rating answer for question_id is >= this value. Common use: NPS promoters with score_gte=9. Requires question_id.
number
Filter to rows where the rating answer for question_id is <= this value. Common use: NPS detractors with score_lte=6. Requires question_id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
If set, only return rows where this question has a non-empty answer, and only include that question’s answer in each row. Required when using score_lte or score_gte.
boolean
When true, exclude responses that have been archived via the archive_response endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z). Filters statistics to events on or before this date.
string
ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z). Filters statistics to events on or after this date.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 metadata

Input Parameters

string
required
The UUID of the organization to retrieve unused pipeline frontend apps for. You can get organization IDs from actions like POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID of the user to retrieve home settings for. Use ‘@me’ to get settings for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this vision alert configuration.
string ("check" | "disable" | "enable" | "reset" | "snooze" | "threshold_change" | "unsnooze")
Narrow the history to one event kind.
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this data warehouse saved query.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_GET_WAREHOUSE_SAVED_QUERYRetrieve a specific PostHog warehouse saved query, including its creator, query definition, execution status, and latest execution metadata.

Input Parameters

string
required
A UUID string identifying this data warehouse saved query.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this data warehouse table.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
A search term to filter warehouse tables by name.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this web experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Filter web vitals by pathname. Specify the page path to get web vitals data for (e.g., /home, /about).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The full source of the cell being edited.
string
required
Short id.
integer
required
Character offset of the cursor in code, counting from 0.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
0 for the signature and docstring, 1 to add the source when the kernel can find it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the run, as returned by the run dispatch endpoint.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the whole-notebook run, as returned by the run endpoint.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_INVOKE_CANVAS_ACTIONInvoke canvas action in a PostHog project. Invoke one registered action verb as the viewer.

Input Parameters

string
required
A UUID string identifying this canvas.
string
required
Registered verb to invoke, e.g. ‘tasks.create’.
object
Verb-specific arguments, validated against the verb’s payload schema.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LAUNCH_EXPERIMENTLaunch experiment in a PostHog project. Launch a draft experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ACCOUNT_NOTEBOOKSList account notebooks in a PostHog project. Returns one page; use the documented pagination parameters for additional pages.

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
Full-text search across notebook title and content.
string ("-created_at" | "-created_by" | "created_at" | "created_by")
Sort by creation date or author. Defaults to ‘-created_at’.
string
required
UUID of the parent account.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ACTION_SELECTOR_MATCH_CHANGESList selector match changes in a PostHog project.

Input Parameters

string ("csv" | "json")
Format.
array
required
Action IDs used by the insight. Accepts repeated or comma-separated values.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONSList projects from the current organization in the authenticated user’s profile, with organization context and counts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_AND_MANAGE_PROJECT_ANNOTATIONSList annotations in a PostHog project, with pagination and search options.

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
A search term.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID (numeric) of the project to list feature flags for. Obtain this from LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS or similar project listing actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The pagination cursor value.
string
Which field to use when ordering the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Batch Export Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Dashboard Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("json" | "txt")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Widget types to return. Omit to return every registered widget type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ENDPOINTSList endpoints in a PostHog project. Returns one page of results with pagination information.

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name for the endpoint
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ERROR_TRACKING_ISSUESList a project’s error-tracking issues with offset pagination.

Input Parameters

integer
Number of issues to return per page.
integer
Zero-based result offset.
string
required
PostHog project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
JSON-encoded list of tag names. Returns experiments carrying at least one of the given tags, e.g. ["growth", "checkout"].
string
Filter to experiments whose metrics reference this event name. Matches events used directly in metric queries as well as events behind any actions those metrics reference.
string
Field to order by. Prefix with ’-’ for descending. Allowlisted fields include name, created_at, updated_at, start_date, end_date, duration, and status.
string
Free-text search applied to the experiment name and its feature flag key (case-insensitive).
string ("all" | "complete" | "draft" | "exposure_frozen" | "paused" | "running" | "stopped")
Filter by experiment status. “running”, “paused”, and “exposure_frozen” are mutually exclusive: “running” returns launched experiments with an active feature flag, “paused” returns launched experiments whose feature flag is deactivated, and “exposure_frozen” returns launched experiments whose exposure was frozen to the already-enrolled cohort while metrics keep flowing. “complete” is an alias for “stopped”. “all” disables status filtering.
boolean
Filter by archived state. Defaults to non-archived experiments only.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Filter to experiments created from an LLM prompt with this name. Matches experiments whose parameters.prompt_metadata.name equals the given value.
string
Filter to experiments created by the given user(s). Accepts a single user ID, or a JSON-encoded / comma-separated list of user IDs to match any of them.
string
JSON-encoded list of tag names. Excludes experiments carrying any of the given tags, even when they also carry non-excluded tags.
integer
Filter to experiments linked to the given feature flag ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_EXPERIMENT_PROMPT_TEMPLATESRetrieve prompt templates in a PostHog project. List the LLM metric templates that can be passed to create_from_prompt.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
ID of the session recording to resolve experiment context for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_EXTERNAL_DATA_SOURCE_JOBSList up to 50 newest synchronization jobs for one external data source, optionally filtered by creation time and schema name. Older jobs cannot be paged.

Input Parameters

string
required
UUID identifying the external data source.
string
ISO 8601 timestamp; return jobs created after this time.
string
ISO 8601 timestamp; return jobs created before this time.
array
Schema names whose synchronization jobs should be returned.
string
required
PostHog project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_FEATURE_FLAG_MY_FLAGSList current user’s flags in a PostHog project.

Input Parameters

string
Groups for feature flag evaluation (JSON object string)
array
Optional list of flag keys to scope the response to. When omitted, every flag in the project is returned with its evaluated value, which can be a very large payload on projects with many flags. Pass the specific flag(s) you want to check to keep the response small. Accepts either repeated query params (flag_keys=a&flag_keys=b) or a JSON array string (flag_keys=[“a”,“b”]).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Feature Flag Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
A search term to filter file system resources.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_GROUP_ACTIVITYRetrieve group activity in a PostHog project.

Input Parameters

integer
Activity page number to retrieve.
integer
Maximum activity entries in this page.
string
required
Key identifying the group within its group type.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Specify the group type to find

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The pagination cursor value.
string
required
Search the group name
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Specify the group type to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The interaction type to return. One of: ‘click’ (default), ‘rageclick’, ‘mousemove’, or ‘scrolldepth’. Scrolldepth returns scroll buckets instead of x/y coordinates.
integer
Maximum interactions to return (1-100).
string
JSON array of event filters (e.g. ’[{“id”: “purchase”, “properties”: []}]’) to restrict results to sessions in which those events occurred. Each entry needs a string ‘id’ (the event name) and may carry a ‘properties’ array of property filters applied to that event, each of type ‘event’ or ‘element’. Several entries are combined with AND: the session must contain a matching event for every entry. At most 10 entries, each with at most 20 property filters. Requires project-wide heatmap access, since the filter reads the project’s events rather than one saved heatmap. Feature-flagged; ignored when the event filter is not enabled for the caller.
integer
Number of interactions to skip, for pagination.
string
required
JSON array of the heatmap coordinates to drill into, e.g. ’[{“x”: 0.5, “y”: 100}]’. Each point needs ‘x’ (relative x, 0..1) and ‘y’ (absolute client-y pixels) matching values returned by the heatmaps list endpoint; an optional ‘target_fixed’ boolean matches fixed-position elements. Returns the individual session interactions behind those spots.
string
End of the window, inclusive. Relative or absolute ‘YYYY-MM-DD’. Defaults to today.
string
Start of the window. Relative (e.g. ‘-7d’, ‘-30d’, ‘-1mStart’) or an absolute ‘YYYY-MM-DD’ date. Defaults to ‘-7d’. Heatmap data is retained for 90 days.
string
Match a single page by exact URL (trailing slash is ignored). Mutually exclusive with url_pattern.
string
JSON array of cohort IDs (e.g. ‘[123, 456]’) to restrict results to people in those cohorts. Feature-flagged; ignored when the cohort filter is not enabled for the caller.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string ("unique_visitors" | "total_count")
How to aggregate counts: ‘total_count’ (every interaction, default) or ‘unique_visitors’ (distinct people). * unique_visitors - unique_visitors * total_count - total_count
string
Match pages by regex against the full current_url (anchored automatically). Use this to aggregate across query strings or path segments. Mutually exclusive with url_exact.
string
Exclusive UTC instant. Supply with timestamp_from to override date bounds.
string
Inclusive UTC instant. Supply with timestamp_to to override date bounds.
integer
Only include interactions captured at a viewport at most this wide, in CSS pixels.
integer
Only include interactions captured at a viewport at least this wide, in CSS pixels. Use with viewport_width_max to isolate a device class (e.g. 360-768 for mobile).
boolean
When true, exclude sessions from internal/test accounts using the project’s test-account filters.
boolean
When true (default), drop interactions recorded at the (0, 0) origin, which are usually noise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of hits to return (default: 100, max: 1000)
integer
Pagination offset for retrieving additional results (default: 0)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Filter hits for specific breakpoints. For multiple IDs, repeat the parameter (e.g., ?breakpoint_ids=uuid1&breakpoint_ids=uuid2)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Only return enabled breakpoints. When true, filters the results to show only active breakpoints.
string
Filter breakpoints for a specific file. Provide the filename to narrow down results to a particular source file.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS.
string
Filter breakpoints for a specific repository. Format: ‘Owner/RepoName’ (e.g., ‘PostHog/posthog’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Return the version each prompt’s label points to, omitting prompts without this label. If omitted, return latest versions.
integer
Number of results to return per page.
integer
The initial index from which to return results.
string
Substring filter on prompt names and content.
string ("full" | "preview" | "none")
Content to include: full prompt and config, short prompt_preview, or none. Outline is always included. Server default: full.
boolean
Resolve @@@prompt:…@@@ references in labeled results with full content. Set false for raw reference tags. Server default: true.
boolean
Return archived instead of active prompts, once per prompt at its most recent version. Defaults to false on the server.
string ("name" | "-name" | "created_at" | "-created_at" | "updated_at" | "-updated_at" | "version" | "-version" | "latest_version" | "-latest_version" | "version_count" | "-version_count" | "first_version_created_at" | "-first_version_created_at" | "prompt_size_bytes" | "-prompt_size_bytes")
Sort field; prefix with ’-’ for descending order. Server default: -created_at.
string
required
Project ID. Discover available projects using /api/projects/.
integer
Filter by the ID of the user who created the prompts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
If any value is provided for this parameter, return notebooks created by the logged in user.
integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
Filter for notebooks created before this date & time
string
Filter for notebooks that match a provided filter. Each match pair is separated by a colon, multiple match pairs can be sent separated by a space or a comma
string
Filter for notebooks created after this date & time
integer
The UUID of the Notebook”s creator
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_OR_DELETE_PERSONS_WITH_OPTIONAL_FILTERSList persons in a PostHog project with optional filters and pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ORGANIZATION_BATCH_EXPORTSRetrieve paginated batch exports for an organization, including team, interval, and status details. Supports limit and offset pagination and uses Personal API key authentication.

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page
integer
The initial index from which to return the results
string
required
UUID of the organization whose integrations you want to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of members to return per page (default: 100). Use smaller values for faster responses.
integer
Number of members to skip before starting to return results (default: 0). Use with limit for pagination.
string
required
UUID of the organization whose members you want to list. You can get this from the current user profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ORGANIZATION_PIPELINE_DESTINATIONSRetrieve a paginated list of an organization’s pipeline destinations by ID, with optional limit and offset parameters. Requires PersonalAPIKeyAuth (plugin:read).

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of frontend apps to return per page (optional). Use for pagination.
integer
Starting index for pagination (optional). Use with limit to fetch specific pages.
string
required
Organization UUID (required). The organization whose frontend apps you want to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ORGANIZATION_PIPELINE_TRANSFORMATIONSRetrieve a paginated list of an organization’s pipeline transformations using limit and offset. Requires an organization ID and PersonalAPIKeyAuth.

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
The unique identifier (UUID) of the organization whose plugins you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_ORGANIZATION_PROJECTSList projects for a specified organization, with optional limit and offset pagination.

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Organization ID (UUID format, e.g., ‘019690d1-9c3f-0000-8dcf-9601a9a5ac90’). Use POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LIST to get valid organization IDs. Cannot be empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of proxy records to return per page (default varies by API). Use with ‘offset’ for pagination.
integer
The starting index for results (0-based). For example, offset=10 skips the first 10 records. Use with ‘limit’ for pagination.
string
required
The UUID of the organization to retrieve proxy records from. Example: ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page. If not specified, all roles are returned.
integer
The initial index from which to return the results. Use with limit for pagination.
string
required
The UUID of the organization whose roles you want to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_PERSON_COHORTSRetrieve cohorts for a person in a PostHog project.

Input Parameters

string ("csv" | "json")
Format.
string
required
The person ID or UUID to get cohorts for.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
string ("csv" | "json")
Format.
integer
The initial index from which to return the results.
string ("all" | "completed" | "pending")
Filter by deletion status: ‘pending’, ‘completed’, or ‘all’.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Filter by a specific person UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
Format.
string
The person_id (UUID) to build properties for (mutually exclusive with distinct_id)
string
required
ISO datetime string for the point in time (e.g., ‘2023-06-15T14:30:00Z’)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
The distinct_id of the person (mutually exclusive with person_id)
boolean
Whether to handle $set_once operations (default: false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page. If not specified, returns all results.
integer
The initial index from which to return the results. Use with limit for pagination.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page. If not specified, returns all results.
integer
The initial index from which to return the results. Use with limit for pagination.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
A search term.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
string ("csv" | "json")
Format
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Plugin Config Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS or POSTHOG_RETRIEVE_CURRENT_USER_PROFILE.
integer
required
The unique integer identifier of the dashboard. Use POSTHOG_LIST_PROJECT_DASHBOARDS_WITH_PAGINATION to find available dashboard IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of dashboard templates to return per page (for pagination). If not specified, returns all available templates.
integer
Number of templates to skip before starting to return results (for pagination). Use with ‘limit’ to paginate through results.
string
required
The numeric ID of the PostHog project. You can find this by calling list_all_projects_across_organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The numeric ID of the PostHog project (e.g., ‘302160’). To find available project IDs, use the list_all_projects action. Note: This must be the numeric project ID, not the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/ or use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE. Note: This endpoint only works for projects with access_control enabled (private projects). Projects without access_control will return a 404 error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of pipeline transformation configurations to return per page. If not specified, the API will use its default page size.
integer
The initial index from which to return results (used for pagination). For example, offset=10 will skip the first 10 results.
string
required
Project ID of the project whose pipeline transformation configurations you want to list. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of plugin configurations to return per page. If not specified, the API will use its default page size.
integer
The initial index from which to return results (used for pagination). For example, offset=10 will skip the first 10 results.
string
required
Project ID of the project whose plugin configurations you want to list. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
The unique identifier (UUID) of the role for which to list memberships. Use the organization roles list endpoint to get valid role IDs.
string
required
The unique identifier (UUID) of the organization containing the role. Use the organization list or details endpoints to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of playlists to return per page. Useful for pagination. If not specified, API will use its default page size.
integer
Number of playlists to skip before returning results. Use with ‘limit’ for pagination (e.g., offset=10, limit=10 for page 2).
string
Filter by the short alphanumeric ID of a specific playlist (e.g., ‘ReFeVQ8X’). Note: In testing, this parameter may not filter results as expected.
integer
Filter playlists by the ID of the user who created them. Use this to find playlists created by a specific team member.
string
required
Project ID (numeric) of the PostHog project. This is the numeric ‘id’ field from project objects, not the UUID. Required path parameter. Example: ‘302160’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Recording Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_SIGNAL_REPORTSList signal reports for a PostHog project with filters and pagination.

Input Parameters

string
Sort mode for the signal reports, such as ‘newest’.
string
Signal report view to return, such as ‘all’.
integer
Maximum number of signal reports to return on this page.
string ("for_me" | "entire_project" | "teammate")
Reviewer scope: for_me, entire_project, or teammate; teammate requires teammate_uuid.
string
Comma-separated scout skill-name slugs whose contributed reports should be included.
integer
Zero-based result offset for pagination.
string
Case-insensitive substring to match against report titles and summaries.
string
Comma-separated report statuses to include, such as ready, resolved, failed, or suppressed.
boolean
Filter by the current user’s report read state.
string
Return only reports associated with this task ID.
string
Set to ‘me’ to return reports claimed by the current user, task, or MCP agent.
string
Field expression the provider should use to order reports.
string
Comma-separated priorities to include: P0, P1, P2, P3, or P4.
string
Comma-separated source record IDs to include; requires exactly one source_product.
boolean
Filter by whether a report has no owner and no draft, open, or unknown pull request.
string
Return reports assigned to this space or channel ID.
boolean
Return the filtered count with an empty results page, skipping report serialization.
string
required
ID of the PostHog project whose signal reports to list.
string
Include reports contributed by scouts whose skill name starts with this prefix.
string
Comma-separated actionability judgments to include: immediately_actionable, requires_human_input, or not_actionable.
string
ISO 8601 datetime; return reports created at or after this time.
string
PostHog user UUID to use when scope is teammate.
string
Comma-separated source products to include, such as error_tracking or session_replay.
boolean
Filter by whether the latest actionability judgment says the issue is already being handled.
string
Comma-separated PostHog user UUIDs; include reports suggesting any of these reviewers.
boolean
Include reports in every non-deleted status, including suppressed reports normally hidden by default.
boolean
Filter reports by whether they have an implementation pull request.
boolean
Whether to populate source_products and scout_name from source metadata; defaults to true.
boolean
When priority is omitted, apply the requesting user’s priority threshold or the project fallback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_LIST_UNUSED_ORGANIZATION_PIPELINE_TRANSFORMATIONSRetrieve a list of unused pipeline transformations for a specified organization, identified by UUID. Includes details like name, plugin type, and configuration. Supports JSON response format.

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
boolean
Filter users by staff status. Set to true to return only staff users, false to return only non-staff users, or omit to return all users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A page number within the paginated result set.
string
A search term to filter warehouse saved queries.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_MANAGE_FEATURE_FLAG_ENRICHMENT_FOR_USAGE_DASHBOARDRequest usage-dashboard enrichment for a feature flag in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
Key
string
contains the description for the flag (field name name is kept for backwards-compatibility)
array
Tags
boolean
Active
boolean
Deleted
object
Filters
object
Surveys
boolean
Can Edit
object
Features
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Experiment Set
boolean
Is Simple Flag
integer
Usage Dashboard
boolean
Performed Rollback
integer
Rollout Percentage
string
Rollback Conditions
array
Analytics Dashboards
boolean
Has Enriched Analytics
boolean
Ensure Experience Continuity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_MANAGE_PROJECT_ANNOTATIONSCreate an annotation for a PostHog project.

Input Parameters

integer
required
Id
string ("dashboard_item" | "dashboard" | "project" | "organization")
  • dashboard_item - insight * dashboard - dashboard * project - project * organization - organization
string
Content
boolean
Deleted
string
required
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Updated At
string
Date Marker
integer
required
Dashboard Id
string
required
Insight Name
string ("USR" | "GIT")
  • USR - user * GIT - GitHub
integer
Dashboard Item
string
required
Dashboard Name
string
required
Insight Short Id
string
required
Insight Derived Name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_MARK_DASHBOARD_TEMPLATE_AS_DELETEDSend a delete request for a dashboard template in a PostHog project.

Input Parameters

string
required
A UUID string identifying this dashboard template.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
Response format: ‘json’ or ‘csv’. Controls the serialization format of the response data. Defaults to JSON if not specified.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
required
List of unique integer values identifying the insights to mark as viewed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
Response format (csv or json)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
required
List of insight IDs to record as viewed (updates the last_viewed_at timestamp for each insight)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_MIGRATE_EXPERIMENTMigrate experiment in a PostHog project. Move a legacy experiment onto the new experiments engine.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_MOVE_DASHBOARD_TILEMove a tile from one dashboard to another in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying the source dashboard (dashboard to move the tile FROM).
object
required
The tile object containing the tile ID to move.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
The ID of the destination dashboard to move the tile TO.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_MOVE_DASHBOARD_TILE_TO_DASHBOARDMove dashboard tile in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this dashboard.
object
required
Tile to move, identified by its dashboard tile ID. Object fields: {“id”: {“type”: “integer”, “description”: “Dashboard tile ID to move.”}} Required object fields: id.
string ("json" | "txt")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Destination dashboard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_MOVE_FILE_SYSTEM_ITEMMove a PostHog file-system item or folder to a new path.

Input Parameters

string
required
UUID of the file-system item to move.
string
required
Destination path for the file-system item.
string
required
PostHog project ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this alert configuration.
string
Alert name. Maximum 255 characters.
object
Alert configuration settings
boolean
Whether the alert is enabled
integer
Insight ID monitored by this alert
object
Alert condition configuration
object
Alert threshold object
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Whether to skip checks during weekends
string
ISO 8601 timestamp until which the alert is snoozed
array
User IDs to subscribe to this alert
string
Calculation interval for the alert (can be string or object)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying the batch export to update
string
A human-readable name for this batch export
string
Which model this batch export is exporting (e.g., events, persons, sessions)
string
ISO 8601 timestamp - time after which any batch export runs won’t be triggered
boolean
Whether this batch export is paused or not. Set to true to pause, false to resume
object
A schema of custom fields to select when exporting data
object
Filter configuration to specify which data to export
string ("hour" | "day" | "week" | "every 5 minutes")
Enum for batch export interval options
string
ISO 8601 timestamp - time before which any batch export runs won’t be triggered
integer
Day offset for the batch export schedule (0-6, where 0 is Sunday)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/
object
Destination configuration for batch export
string
HogQL query string for filtering or transforming exported data
integer
Hour offset for the batch export schedule (0-23)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this project
string ("product_analytics" | "session_replay" | "feature_flags" | "surveys" | "error_tracking" | "data_warehouse")
required
The product type to mark as onboarding complete. Valid values include: product_analytics, session_replay, feature_flags, surveys, error_tracking, data_warehouse
string
required
Organization UUID that owns the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this customer profile config.
string ("person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4")
Scope of the customer profile configuration
object
Content configuration for the customer profile. Can be any JSON object with arbitrary fields.
object
Sidebar configuration for the customer profile. Can be any JSON object with arbitrary fields.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_DATASETPartially update a dataset in a PostHog project, including its name, description, or soft-delete status. Only supplied fields are sent.

Input Parameters

string
required
A UUID string identifying this dataset.
string
Dataset name (max 400 characters)
boolean
Soft-delete indicator for the dataset
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Dataset description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this dataset item.
object
Input data for the dataset item
object
Output data for the dataset item
boolean
Whether the dataset item should be marked as deleted
object
Metadata associated with the dataset item
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Reference trace ID (max 255 characters)
string
Reference source ID (max 255 characters)
string
Reference timestamp (ISO 8601 datetime format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name for the endpoint
object
Query configuration for the endpoint
boolean
Whether the endpoint is active
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description for the endpoint
boolean
Whether the endpoint query is materialized
integer
Cache age in seconds for the endpoint
string
Insight ID from which this endpoint is derived

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking auto capture controls.
string
Library identifier for error tracking configuration
string ("all" | "any")
Match type for triggers: ‘all’ means all conditions must match, ‘any’ means at least one condition must match
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Sample rate for error tracking (decimal string format between -1.00 and 1.00, e.g., ‘0.95’ for 95%)
array
List of URL patterns that trigger error tracking
array
List of URL patterns to exclude from error tracking
array
List of event triggers that activate error tracking autocapture
string
Feature flag linked to this autocapture control (can be a string ID or a feature flag object)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this evaluation
string
Name of the evaluation (max 400 characters)
boolean
Whether the evaluation is deleted
boolean
Whether the evaluation is enabled
string
Conditions for the evaluation
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/
string
Description of the evaluation
string ("boolean")
Output type enum
object
Output configuration
string ("llm_judge")
Evaluation type enum
object
Configuration for the evaluation
object
Model configuration for evaluation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_EXPERIMENTPartially update an experiment in a project using the project ID and experiment ID. Returns updated details and requires authentication.

Input Parameters

string
required
Id
string
Name
string
Filters
boolean
Archived
string
End Date
string
Created At
string
Parameters
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Start Date
string
Updated At
string
Description
integer
Exposure Cohort
string
Feature Flag Key
string
Secondary Metrics

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment saved metric.
string
Name of the experiment saved metric (max 400 characters)
array
List of tags associated with the saved metric
object
Query configuration for the saved metric
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the experiment saved metric (max 400 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this external data source.
string
Prefix to apply to data imported from this source
string
Account identifier for the external data source
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the external data source (maximum 400 characters)
string
Client secret for authenticating with the external data source
object
Revenue analytics configuration for the external data source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this file system.
string
Reference identifier for the file system (max 100 characters)
string
URL reference to the file system resource
object
Additional metadata associated with the file system
string
Path of the file system resource
string
Type of the file system resource (max 100 characters)
integer
Depth level of the file system resource
boolean
Whether this file system is a shortcut
string
ISO 8601 timestamp of when the file system was created
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
ISO 8601 timestamp of when the file system was last viewed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this file system shortcut.
string
Reference identifier for the shortcut, maximum length 100 characters.
string
The URL/link associated with this file system shortcut.
string
The path for the file system shortcut.
string
The type of the file system shortcut (e.g., ‘query’, ‘dashboard’).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this group usage metric.
string
Name of the group usage metric
string ("numeric" | "currency")
Format for the group usage metric
string ("number" | "sparkline")
Display format for the group usage metric
object
Filters to apply to the group usage metric
integer
Interval in days for the metric
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Index of the group type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this hog function.
string
Hog code for the function
string
Name of the hog function (max 400 characters)
string
Type of the hog function
object
Input values for the hog function with bytecode, order, templating, transpiled, and value properties
boolean
Whether the hog function is marked as deleted (soft delete)
boolean
Whether the hog function is enabled
object
Filter configuration for the hog function including actions, events, properties, and source
object
Masking configuration with hash, ttl, bytecode, and threshold properties
string
URL of the icon for the hog function
array
Mappings configuration for the hog function with filters, inputs, inputs_schema, and name properties
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the hog function
string
Template ID (max 400 characters)
array
Schema defining the inputs for the hog function with key and type as required fields
string
UUID of the associated batch export
integer
Execution order of the hog function (0-32767)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this insight variable.
string
Name of the insight variable (max 400 characters)
string ("String" | "Number" | "Boolean" | "List" | "Date")
Type of insight variable
string
Possible values for the insight variable (for List type variables)
string
Code name for the insight variable, used for programmatic access
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Default value for the insight variable. Type depends on the ‘type’ field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this live debugger breakpoint.
boolean
Whether the breakpoint is enabled. Set to false to disable the breakpoint without deleting it.
string
Filename where the breakpoint is set.
string
Condition expression for the breakpoint. If specified, the breakpoint will only trigger when this condition evaluates to true.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Repository identifier for the breakpoint.
integer
Line number where the breakpoint is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_ORGANIZATION_DOMAINUpdates selected properties of a domain in an organization via PATCH request, supports various data formats but SAML fields are immutable. Authentication needed.

Input Parameters

string
required
A UUID string identifying this domain.
string
Domain
string
Saml Acs Url
string
Saml Entity Id
string
Saml X509 Cert
string
required
Organization Id
string
Sso Enforcement
boolean
Jit Provisioning Enabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_ORGANIZATION_ROLEPartially update a role by ID within an organization, including its name.

Input Parameters

string
required
Id
string
Name
string
Members
string
Created At
string
required
Organization Id
string
Associated Flags

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this Persisted Folder.
string
Path of the persisted folder
string ("home" | "pinned" | "custom_products")
Type of the persisted folder: home, pinned, or custom_products
string
Protocol used for the persisted folder (maximum 64 characters)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_PERSONRequest a partial update to a person in a PostHog project, including person properties.

Input Parameters

string
required
Id
string
Name
string
Uuid
string ("csv" | "json")
Format
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Properties
array
Distinct Ids

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this product tour.
string
Name of the product tour (maximum 400 characters).
object
Content of the product tour.
boolean
Whether the product tour is archived.
string
End date for the tour in ISO 8601 format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Start date for the tour in ISO 8601 format.
boolean
Whether the tour should launch automatically.
string
Description of the product tour.
integer
ID of the linked feature flag.
string ("app" | "toolbar")
Enum for creation context values.
object
Targeting flag filters for the tour.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
Name
array
Tags for organizing and categorizing actions.
array
Action steps defining the criteria (event, properties, selectors).
string ("csv" | "json")
Format
boolean
Deleted
integer
Team Id
boolean
Is Action
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
boolean
Post To Slack
string
Bytecode Error
boolean
Is Calculating
string
Last Calculated At
string
Slack Message Format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_PROJECT_ANNOTATIONPartially update an annotation in a PostHog project by its ID.

Input Parameters

string
required
Id
string ("dashboard_item" | "dashboard" | "project" | "organization")
  • dashboard_item - insight * dashboard - dashboard * project - project * organization - organization
string
Content
boolean
Deleted
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Updated At
string
Date Marker
integer
Dashboard Id
string
Insight Name
string ("USR" | "GIT")
  • USR - user * GIT - GitHub
integer
Dashboard Item
string
Dashboard Name
string
Insight Short Id
string
Insight Derived Name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
Name
integer
Count
string
Query
string
Groups
boolean
Deleted
string
Filters
boolean
Is Static
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
array
Experiment Set
boolean
Is Calculating
string
Last Calculation
integer
Errors Calculating

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this dashboard.
string
The display name of the dashboard (e.g., ‘Sales Dashboard’, ‘User Analytics’).
array
List of tags for categorizing and organizing the dashboard (e.g., [‘analytics’, ‘sales’, ‘q1-2024’]).
array
Dashboard tiles/widgets configuration. Each tile represents an insight, text card, or other widget with layout and display settings.
boolean
Whether the dashboard should be pinned to the top for quick access. Set to true to pin, false to unpin.
boolean
Soft delete flag. Set to true to mark the dashboard as deleted without permanently removing it.
string
Dashboard-level filters to apply to all tiles (e.g., date ranges, property filters). Accepts a dictionary with filter configurations.
boolean
Whether the dashboard is shared publicly or with specific users. Set to true to enable sharing.
string
The creation timestamp of the dashboard in ISO 8601 format (e.g., ‘2024-01-15T10:30:00Z’). Typically read-only.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
A detailed description of what this dashboard contains or its purpose.
string
Template ID to apply to this dashboard (e.g., ‘default’, ‘product-analytics’). Useful for creating dashboards from predefined templates.
integer
Dashboard ID to copy/duplicate from. Use this to create a new dashboard based on an existing one’s structure.
boolean
Whether to delete all insights when deleting the dashboard. Set to true to remove insights, false to keep them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_PROJECT_FEATURE_FLAGPartially update a feature flag in a PostHog project by its ID.

Input Parameters

integer
required
A unique integer value identifying this feature flag. Used only as a path parameter.
string
Key
string
contains the description for the flag (field name name is kept for backwards-compatibility)
array
Tags
boolean
Active
boolean
Deleted
object
Filters
object
Surveys
boolean
Can Edit
object
Features
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/. Used only as a path parameter.
array
Experiment Set
boolean
Is Simple Flag
integer
Usage Dashboard
boolean
Performed Rollback
integer
Rollout Percentage
string
Rollback Conditions
array
Analytics Dashboards
boolean
Has Enriched Analytics
boolean
Ensure Experience Continuity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
Name
array
Tags
string
Hogql
integer
Order
string
Query node JSON string
boolean
Saved
string
Types
string ("csv" | "json")
Format
string
Result
string
Columns
boolean
Deleted
string
Filters
string
Short Id
string
The timezone this chart is displayed in.
boolean
Favorited
string
Is Cached
boolean
Is Sample
string
Created At
array
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Updated At
string
Description (max 400 characters)
string
Derived Name
string
The datetime this insight”s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
string
Query Status
array
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
string
The target age of the cached results for this insight.
string
Last Modified At
string
The earliest possible datetime at which we”ll allow the cached results for this insight to be refreshed by querying the database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Id
integer
The access level for the user. Common values: 1 (member), 8 (admin).
string
Joined At
string
User Uuid
string
required
Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint only works for projects with access control enabled (private projects).
string
Updated At
integer
Parent Level
string
Parent Membership Id
string
required
Parent Membership User Uuid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Id
string
Title
string
Content
boolean
Deleted
integer
Version
string
required
Short Id
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Text Content
string
Last Modified At

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PATCH_PROJECT_PROPERTY_DEFINITIONPartially update a project property definition by UUID, including its property type or tags.

Input Parameters

string
required
A UUID string identifying this property definition.
array
List of tags associated with the property definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
The type of property. Possible values include: ‘Boolean’, ‘Numeric’, ‘String’, ‘DateTime’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
integer
Count
string
Title
boolean
Deleted
integer
Insight
string
Summary
integer
Bysetpos
integer
Interval
array
Byweekday
integer
Dashboard
string ("daily" | "weekly" | "monthly" | "yearly" | "hourly")
  • daily - Daily * weekly - Weekly * monthly - Monthly * yearly - Yearly
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Start Date
string
Until Date
string ("email" | "slack" | "webhook")
  • email - Email * slack - Slack * webhook - Webhook
string
Target Value
string
Invite Message
string
Next Delivery Date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Id
string
Name
boolean
Pinned
boolean
Deleted
string
Filters
string
required
Short Id
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
string
Derived Name
string
Last Modified At

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
User UUID to update. Use ‘@me’ to update the authenticated user.
string
User’s email address. Maximum 254 characters. Changing email may require verification.
string
User’s last name. Maximum 150 characters.
string
User’s first name. Maximum 150 characters.
string
UI theme preference (e.g., ‘light’, ‘dark’, ‘auto’).
boolean
Whether to anonymize the user’s data in analytics.
string
Team UUID to set as the current active team (project) for the user.
boolean
Whether to allow staff to impersonate this user for support purposes.
string ("engineering" | "data" | "product" | "founder" | "leadership" | "marketing" | "sales" | "other")
User’s role at their organization
object
User notification preferences. Keys represent notification types, values represent whether they are enabled.
boolean
Whether passkeys are enabled for two-factor authentication. Users can disable this to use only TOTP for 2FA while keeping passkeys for login.
string
Organization UUID to set as the current active organization for the user.
boolean
Whether to show sidebar suggestions in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this data warehouse saved query.
string
User-defined name of the saved query (max 128 characters)
string
HogQL query definition for the saved query
string
Where this SavedQuery is created. Can be ‘data_warehouse’, ‘endpoint’, or ‘managed_viewset’.
string
The status of when this SavedQuery last ran. Can be ‘Cancelled’, ‘Modified’, ‘Completed’, ‘Failed’, or ‘Running’.
string
Column definitions for the saved query results
boolean
Soft-delete indicator. When true, the saved query is marked as deleted.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Indicates if soft update is enabled
string
Frequency at which the query syncs
boolean
Indicates if the query results are materialized

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this data warehouse table.
string
Name of the warehouse table (maximum 128 characters)
string ("CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper")
Supported data warehouse table formats
string
Column definitions for the warehouse table
boolean
Whether the warehouse table is marked as deleted
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
URL pattern for accessing the warehouse table data (maximum 500 characters)
string
External schema definition for the warehouse table

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this web experiment.
string
Name of the web experiment (max 400 characters)
object
Variants configuration for the web experiment. Keys are variant names (e.g., ‘control’, ‘variant’), values are variant configurations with transforms and rollout percentages
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Feature flag key to associate with this web experiment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying the batch export to pause
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PAUSE_EXPERIMENTPause experiment in a PostHog project. Pause a running experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PAUSE_ORGANIZATION_BATCH_EXPORTPause an organization-level batch export in PostHog. Use when you need to temporarily stop scheduled data exports at the organization level without deleting the batch export configuration.

Input Parameters

string
required
A UUID string identifying the batch export to pause
string
required
UUID of the organization that owns the batch export

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_PIN_NOTEBOOK_WIDGETPin notebook widget in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.

Input Parameters

string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Immutable version to pin, or null to follow the reusable widget’s latest version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name for the endpoint
integer
Endpoint version to preview. Defaults to the current version.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
object
Per-column bucket function overrides, e.g. {“timestamp”: “hour”}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
List of events to include in the funnel. Each event must have: ‘id’ (event name), ‘type’ (‘events’), and ‘order’ (step number starting from 0). At least 2 steps are required. Example: [{‘id’: ‘pageview’, ‘type’: ‘events’, ‘order’: 0}, {‘id’: ‘signup’, ‘type’: ‘events’, ‘order’: 1}]. One of ‘events’ or ‘actions’ is required.
string ("csv" | "json")
Response format: ‘json’ (default) for structured data or ‘csv’ for spreadsheet export.
array
List of actions to include in the funnel. Each action must have: ‘id’ (action ID), ‘type’ (‘actions’), and ‘order’ (step number starting from 0). At least 2 steps are required. One of ‘events’ or ‘actions’ is required.
string
End date for the funnel analysis. Can be a date ‘2021-01-01’ or relative like ‘-7d’, ‘-1m’, ‘mStart’, ‘yStart’. If not specified, defaults to now.
string
Property or cohort to break down results by. Type is specified with breakdown_type: ‘event’ (default) - event property key; ‘person’ - person property key; ‘cohort’ - array of cohort IDs like [9581,5812].
string
Start date for the funnel analysis. Can be a date ‘2021-01-01’ or relative like ‘-7d’ (last 7 days), ‘-1m’ (last month), ‘mStart’ (start of month), ‘yStart’ (start of year). Defaults to ‘-7d’.
array
Exclude users/groups that completed the specified event between two specific steps. Note that these users/groups will be completely excluded from the entire funnel.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
object
Additional property filters to apply to the funnel query. Filters events based on property conditions.
string ("event" | "person" | "cohort")
Type of breakdown property: ‘event’ for event properties, ‘person’ for user properties, ‘cohort’ for cohort segmentation. Used with ‘breakdown’ parameter.
integer
Maximum number of breakdown values to return. Default is 10.
string ("steps" | "time_to_convert" | "trends")
Funnel visualization type: ‘steps’ (default, shows conversion at each step), ‘time_to_convert’ (shows time between steps), ‘trends’ (shows funnel over time).
string ("ordered" | "unordered" | "strict")
Order requirement for funnel steps: ‘ordered’ (default, steps in sequence with others allowed between), ‘strict’ (steps in exact sequence with nothing between), ‘unordered’ (steps in any order).
integer
(DEPRECATED) Funnel window size in days. Use funnel_window_interval and funnel_window_interval_type
boolean
Whether to filter out internal and test accounts. See “project settings” in your PostHog account for the filters.
integer
Funnel conversion window size (numeric value). Used with funnel_window_interval_type to define the time window for completing the funnel. Default is 14 (14 days).
string ("day" | "hour" | "minute" | "week" | "month")
Unit for funnel_window_interval: ‘day’, ‘hour’, ‘minute’, ‘week’, or ‘month’. Default is ‘day’.
integer
Aggregation level: 0 for user-level (default), >0 for group-level aggregation. Group index corresponds to your configured group types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Events to filter on. One of events or actions is required.
string ("csv" | "json")
Format
array
Actions to filter on. One of events or actions is required.
boolean
To compare or not
string
What date to filter the results to. Can either be a date 2021-01-01, or a relative date, like -7d for last seven days, -1m for last month, mStart for start of the month or yStart for the start of the year.
string
Combine the result of events or actions into a single number. For example A + B or (A-B)/B. The letters correspond to the order of the events or actions lists.
string
A property or cohort to break down on. You can select the type of the property with breakdown_type. - event (default): a property key - person: a person property key - cohort: an array of cohort IDs (ie [9581,5812])
string
What date to filter the results from. Can either be a date 2021-01-01, or a relative date, like -7d for last seven days, -1m for last month, mStart for start of the month or yStart for the start of the year.
string
What to compare to
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Whether to filter out internal and test accounts. See “project settings” in your PostHog account for the filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name shown in the reusable widget catalog.
array
Searchable labels attached to the reusable widget.
string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Short explanation of what the reusable widget shows and when to use it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_QUERY_EXPERIMENT_SESSION_BUCKETQuery an experiment session bucket in a PostHog project and return matching session IDs for recordings.

Input Parameters

integer
required
A unique integer value identifying this experiment.
integer
Maximum session IDs to return, at most 100. The most recently active matching sessions win.
string ("fired_any" | "no_metric_activity" | "funnel_dropoff")
required
Which question the returned session set answers. ‘fired_any’: the session fired at least one event of any listed metric (an OR the recordings query itself can’t express). ‘no_metric_activity’: the session fired none of them. ‘funnel_dropoff’: the session saw an exposure event but never fired the funnel metric’s last step; the exposure is the funnel’s implicit first step, the same as in the experiment analysis. All three are session-scoped and goal-free: they say what happened in the session, not whether it helped or hurt the metric. * fired_any - fired_any * no_metric_activity - no_metric_activity * funnel_dropoff - funnel_dropoff
string
Restrict to sessions that saw this variant. Omit for every variant. A session that saw more than one variant matches each variant it saw.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Metrics the bucket is computed over. Exactly one funnel metric for ‘funnel_dropoff’. Omit for the other buckets to use every metric of the experiment that can be matched to recordings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_QUERY_LOGSQuery project logs using typed filters and cursor pagination.

Input Parameters

object
required
Typed filters, ordering, pagination, and output options for the logs query.
string
required
PostHog project ID. Find it with the projects API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_QUERY_METRICSQuery metrics in a PostHog project.

Input Parameters

object
required
Query configuration. Unset fields use the provider defaults.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_QUERY_TRACING_SPANSQuery tracing spans in a PostHog project.

Input Parameters

object
required
Query configuration. Unset fields use the provider defaults.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Unique identifier of the frontend app configuration to rearrange
string
Human-readable name of the frontend app
string
Error message if the frontend app configuration has encountered any issues
integer
Display/execution order of the frontend app (lower numbers appear/execute first)
string
JSON string containing the frontend app’s configuration settings
integer
ID of the plugin/frontend app associated with this configuration
boolean
Soft deletion flag - if true, the configuration is marked as deleted but not removed
boolean
Whether the frontend app is enabled (true) or disabled (false)
string
Optional filters to apply to the frontend app’s data processing or display logic
integer
Team ID associated with this configuration (usually same as project)
string
ISO 8601 timestamp when the configuration was created
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
ISO 8601 timestamp when the configuration was last updated
string
Brief description of what the frontend app does
string
Additional metadata about the plugin in JSON format
string
The delivery/success rate of the frontend app over the last 24 hours

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The ID of the specific transformation config to rearrange. You can get this from the list endpoint.
string
Human-readable name for this transformation configuration. Helps identify the transformation in the UI and logs.
string
Error message if the transformation has encountered any issues. Typically read-only and managed by the system.
integer
The execution order of this transformation in the pipeline. Lower numbers execute first. Use this to control the sequence in which transformations are applied to your events.
string
Configuration settings for this transformation as a JSON string. The exact structure depends on the specific transformation plugin being used.
integer
The plugin ID associated with this transformation. This identifies which transformation plugin is being configured.
boolean
Soft delete flag. Set to true to mark this transformation as deleted without permanently removing it from the database.
boolean
Whether this transformation is enabled (true) or disabled (false). Disabled transformations will not process events.
string
Filter conditions that determine which events this transformation processes. Can be a JSON object defining event property filters, event name filters, etc.
integer
The team ID associated with this project. Usually automatically set based on the project.
string
ISO 8601 timestamp of when this transformation config was created. Typically read-only and managed by the system.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
ISO 8601 timestamp of when this transformation config was last updated. Automatically updated by the system when changes are made.
string
Detailed description of what this transformation does. Use this to document the transformation’s purpose and behavior.
string
Additional information about the plugin as a JSON string. Contains metadata like plugin name, description, and capabilities.
string
The delivery success rate for this transformation over the last 24 hours. Typically read-only and used for monitoring transformation performance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Id
string
Name
string
Error
integer
Order
string
Config
integer
Plugin
boolean
Deleted
boolean
Enabled
string
Filters
integer
Team Id
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Updated At
string
Description
string
Plugin Info
string
Delivery Rate 24H

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The ID of the specific destination config to rearrange. You can get this from the list endpoint.
string
Human-readable name for this destination configuration. Helps identify the destination in the UI and logs.
string
Error message if the destination has encountered any issues. Typically read-only and managed by the system.
integer
The execution order of this destination in the pipeline. Lower numbers execute first. Use this to control the sequence in which destinations receive your events.
string
Configuration settings for this destination as a JSON string. The exact structure depends on the specific destination plugin being used.
integer
The plugin ID associated with this destination. This identifies which destination plugin is being configured.
boolean
Soft delete flag. Set to true to mark this destination as deleted without permanently removing it from the database.
boolean
Whether this destination is enabled (true) or disabled (false). Disabled destinations will not receive events.
string
Filter conditions that determine which events this destination receives. Can be a JSON object defining event property filters, event name filters, etc.
integer
The team ID associated with this project. Usually automatically set based on the project.
string
ISO 8601 timestamp of when this destination config was created. Typically read-only and managed by the system.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
ISO 8601 timestamp of when this destination config was last updated. Automatically updated by the system when changes are made.
string
Detailed description of what this destination does. Use this to document the destination’s purpose and behavior.
string
Additional information about the plugin as a JSON string. Contains metadata like plugin name, description, and capabilities.
string
The delivery success rate for this destination over the last 24 hours. Typically read-only and used for monitoring destination performance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RECALCULATE_EXPERIMENT_METRICSRecalculate experiment metrics in a PostHog project. Trigger a batch recalculation of all metrics for this experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string ("manual" | "manual_retry" | "cold_run" | "stale_refresh" | "heal_latest_run" | "experiment_config_change" | "metric_config_change")
What triggered this recalculation (manual is the default for user-initiated runs). Only client triggers are accepted; agent_mcp, timeseries_sync and scheduled are set by the server. * 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 Change
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
object
required
The full metric object to recalculate. This should contain the metric configuration including type (e.g., ‘primary’, ‘secondary’) and other relevant metric properties.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The fingerprint of the metric configuration. This is used to identify the specific metric configuration for recalculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The ID of the plugin configuration to modify.
string
Display name for the plugin configuration.
string
Error message if the plugin configuration has issues.
integer
The execution order of this plugin configuration. Lower numbers run first.
string
JSON string containing the plugin configuration settings.
integer
The plugin ID associated with this configuration.
boolean
Whether this plugin configuration has been soft-deleted.
boolean
Whether the plugin configuration should be enabled or disabled.
string
Filter criteria for when this plugin should process events.
integer
Team ID associated with this plugin configuration. Usually derived from project_id.
string
Timestamp when the plugin configuration was created (ISO 8601 format).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Timestamp when the plugin configuration was last updated (ISO 8601 format).
string
Human-readable description of what this plugin configuration does.
string
Additional metadata about the plugin.
string
The delivery rate for this plugin over the last 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_REFRESH_DASHBOARD_SHARINGRotate a dashboard sharing access token. Existing share links expire; distribute the returned token to continue sharing.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Dashboard id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_REFRESH_INSIGHT_SHARINGRotate an insight sharing access token. Existing share links expire; distribute the returned token to continue sharing.

Input Parameters

integer
required
Insight id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Notebook id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_REORDER_DASHBOARD_TILESReorder dashboard tiles in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
string ("preserve" | "two_column" | "three_column" | "full_width")
How to size tiles when reordering. ‘preserve’ (default) keeps each tile’s existing width and height and only repacks positions in the new order. Use the other modes only when every tile should use the same size: ‘two_column’ makes every tile 6-wide × 5-tall, ‘three_column’ makes every tile 4-wide × 5-tall, and ‘full_width’ makes every tile 12-wide × 5-tall. * preserve - preserve * two_column - two_column * three_column - three_column * full_width - full_width
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
array
required
Array of tile IDs in the desired display order (top to bottom, left to right).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID of the desktop recording to replace
integer
required
Team ID associated with the recording
string
Additional notes about the recording
string ("recording" | "uploading" | "processing" | "ready" | "error")
Recording status.
string
AI-generated summary of the recording
string ("zoom" | "teams" | "meet" | "desktop_audio" | "slack")
required
Platform where the recording was made: zoom (Zoom), teams (Microsoft Teams), meet (Google Meet), desktop_audio (Desktop audio), or slack (Slack huddle)
string
URL of the video recording
integer
required
User ID of the creator
string
required
Project ID (environment ID) containing the recording. Find it via /api/projects/
string
ISO 8601 timestamp when the recording started
string
URL of the meeting
string
ISO 8601 timestamp when the recording was completed
array
List of participant names
string
Error message if the recording failed
string
Title of the meeting (max 255 characters)
string
required
SDK upload identifier (UUID)
array
AI-extracted tasks from the transcript
string
required
Full text of the transcript
integer
Duration of the recording in seconds
integer
Size of the video in bytes
string
ISO 8601 timestamp when the tasks were generated
string
Recall recording identifier (UUID)
array
Transcript segments with timestamps and speaker information
string
ISO 8601 timestamp when the summary was generated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RESET_EXPERIMENTReset experiment in a PostHog project. Reset an experiment back to draft state.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
Response format (csv or json)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The distinct_id to reset for a deleted person. This allows the distinct_id to be used again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RESUME_EXPERIMENTResume experiment in a PostHog project. Resume a paused experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ASYNC_QUERY_STATUS_BY_IDRetrieve the status of an asynchronous query by project and query ID. Experimental.

Input Parameters

string
required
Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_LAST_VIEWED_INSIGHTS_FOR_USERReturns basic details about the last 5 insights viewed by this user. Most recently viewed first.

Input Parameters

string ("csv" | "json")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint does NOT support Personal API Key access - it requires session-based authentication (browser login). Calling this endpoint with an API key will result in a 403 permission_denied error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_OR_DELETE_PERSON_RETENTION_DATARetrieve person retention data for a PostHog project.

Input Parameters

string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
Response format: ‘json’ returns structured data, ‘csv’ returns comma-separated values.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_FRONTEND_APPRetrieve pipeline frontend app details for an organization using its ‘organization_id’ (UUID). Response includes ID, plugin type, name, URL in JSON format, covering various plugin types.

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_REPOSITORY_DETAILSRetrieve details for repository pipeline destinations within a specific organization by its UUID. Returns objects like ID, name, and URLs with support for various plugin types (local, custom, etc.).

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_TRANSFORMATION_ACTIVIRetrieve org pipeline transformation activity

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID of the organization to retrieve export unsubscribe configurations for (e.g., ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’). Use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE or POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_ACTIVITYRetrieve plugin activity log entries for a specified organization by its UUID. Entries include activity, user, scope, timestamp, and related item details.

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_REPOSITORY_DETAILSRetrieve plugin repository details for a specific organization by its UUID, including plugin type, name, URL, and more. Accessible via GET request to ‘/api/organizations/{organization_id}/plugins/repository/’.

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID of the organization to retrieve plugin export unsubscribe configurations for (e.g., ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’). Use POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LIST or POSTHOG_RETRIEVE_CURRENT_USER_PROFILE to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ORGANIZATION_PROJECT_DETAILSRetrieve details of a specific project in an organization using the organization ID and project ID.

Input Parameters

integer
required
A unique integer value identifying this team (soon to be environment).
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this role.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_ORGANIZATION_UNUSED_PIPELINE_APPSRetrieve unused pipeline import apps for a specified organization. Endpoint requires an organization_id (UUID) and returns details like plugin type, name, description, and more in JSON format.

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this Persisted Folder.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PERSON_ACTIVITY_AND_DELETE_OPTIONSRetrieve activity for a person in a PostHog project.

Input Parameters

string
required
A unique UUID value identifying this person.
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PERSON_DETAILS_BY_IDRetrieve details for a person by ID in a PostHog project.

Input Parameters

string
required
A unique UUID value identifying this person.
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The person property key to retrieve values for. This is a required parameter and cannot be empty. Examples: ‘email’, ‘$geoip_city_name’, ‘$geoip_country_name’, ‘$initial_referrer’, ‘name’, or any custom person property key.
string ("csv" | "json")
Output format for the response. Defaults to JSON if not specified.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
The UUID of the organization to retrieve pipeline destination activity for. Format: UUID string (e.g., ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this plugin config.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PIPELINE_DESTINATION_DETAILSFetch a pipeline destination’s details by ID and organization UUID, using a PersonalAPIKeyAuth with read access to plugins. Returns JSON with plugin info.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PIPELINE_DESTINATION_PLUGIN_DETAILSRetrieve source files for a pipeline destination plugin by ID within an organization. The response maps filenames to source content.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_ACTIVITYRetrieve activity details for pipeline frontend apps within an organization by organization ID. Activity entries include the user, activity, affected item, and timestamp.

Input Parameters

string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 action

Input Parameters

integer
required
Unique integer ID of the pipeline frontend app to retrieve. Use LIST_ORGANIZATION_S_PIPELINE_FRONTEND_APPS to discover available app IDs.
string
required
Organization UUID. The organization that contains the frontend app. Use RETRIEVE_CURRENT_USER_PROFILE to get your organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_SOURCE_DETAILSRetrieve details for a specific pipeline frontend app’s source by its ID within an organization. Requires an integer ID of the app and UUID of the organization. Returns JSON object with app properties.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying the pipeline frontend app config.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PIPELINE_IMPORT_APPS_ACTIVITYRetrieve activity details for pipeline import apps in an organization, with optional limit and offset pagination. Results contain activity entries with users, affected item IDs, timestamps, and change details.

Input Parameters

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique integer ID of the pipeline transformation plugin to retrieve. Obtain from LIST_ORGANIZATION_S_PIPELINE_TRANSFORMATIONS.
string
required
UUID of the organization. Get from RETRIEVE_CURRENT_USER_PROFILE response (organization.id field).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PIPELINE_PLUGIN_SOURCERetrieve source details for a pipeline transformation plugin by ID within an organization. The response model includes type, configuration inputs, and optional Hog source code.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this plugin config.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PLUGIN_SOURCE_DETAILSRetrieve plugin source files by organization UUID and integer plugin ID. The response is a mapping of source filenames to strings.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PLUGIN_UPDATE_INFOThis endpoint retrieves update information for a specific plugin within an organization’s pipeline frontend app by its integer ID and the organization’s UUID. It returns details such as plugin type, name, and latest version.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PLUGIN_UPDATE_STATUSRetrieve the latest update status for a specific plugin, identified by its integer ID, within an organization specified by UUID. Check compatibility and change logs.

Input Parameters

integer
required
A unique integer value identifying this plugin.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this action.
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number of results to return (1-indexed).
integer
Number of results to return per page.
string ("csv" | "json")
Response format: ‘json’ returns structured JSON data (default), ‘csv’ returns CSV-formatted text. Use CSV for spreadsheet exports.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination cursor for fetching subsequent pages. Extract from ‘next’ URL in previous response. Leave empty for first page.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PROJECT_ANNOTATION_DETAILSRetrieve details of a specific annotation in a project using the project ID and annotation ID.

Input Parameters

integer
required
A unique integer value identifying this annotation.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this cohort.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this early access feature.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The event property key to retrieve values for. This is a required parameter and cannot be empty. Examples: ‘$browser’, ‘$geoip_city_name’, ‘$os’, ‘distinct_id’, or any custom event property key.
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The fingerprint of the metric configuration. Required.
string
required
The UUID of the metric to retrieve results for. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this exported asset.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
List of events to include in the funnel. Each event should have ‘id’ (event name), ‘type’ (‘events’), and ‘order’ (step number starting from 0). At least 2 steps are required. One of ‘events’ or ‘actions’ is required.
string ("csv" | "json")
Response format: ‘json’ or ‘csv’.
array
List of actions to include in the funnel. Each action should have ‘id’ (action ID), ‘type’ (‘actions’), and ‘order’ (step number). One of ‘events’ or ‘actions’ is required.
string
End date for the funnel analysis. Can be a date ‘2021-01-01’ or relative like ‘-7d’, ‘-1m’, ‘mStart’, ‘yStart’.
string
Type of insight. For funnel correlation, should be ‘FUNNELS’.
string
Start date for the funnel analysis. Can be a date ‘2021-01-01’ or relative like ‘-7d’, ‘-1m’, ‘mStart’, ‘yStart’.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Whether to filter out internal and test accounts. See “project settings” in your PostHog account for the filters.
integer
Funnel conversion window size (used with funnel_window_interval_type). Defaults to 14 days.
string ("events" | "properties" | "event_with_properties")
Type of correlation to analyze: ‘events’, ‘properties’, or ‘event_with_properties’.
string
Unit for funnel window interval: ‘day’, ‘hour’, ‘minute’, ‘week’, or ‘month’. Defaults to ‘day’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Specify the key of the group to find
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Specify the group type to find

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this insight.
integer
Page number of results to return (1-indexed).
integer
Number of results to return per page.
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Numeric primary key or 8-character alphanumeric short_id identifying this insight.
string ("csv" | "json")
Format
string
Refresh execution mode: force_cache never calculates; blocking calculates synchronously if stale; async calculates in the background if stale; lazy_async allows older cached results; force_blocking and force_async always calculate; async_except_on_cache_miss blocks only on a cache miss. Legacy boolean values are also supported. Omitted by default so the provider chooses its default. Background calculation is tracked in query_status.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
When loading an insight for a dashboard pass a from_dashboard query parameter containing the dashboard ID e.g. "/api/projects/{team_id}/insights/{insight_id}?from_dashboard={dashboard_id}" Insights can be added to more than one dashboard, this allows the insight to be loaded in the correct context. Using the correct cache and enriching the response with dashboard specific config (e.g. layouts or colors)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
string ("csv" | "json")
Format
integer
The initial index from which to return the results.
string
Short Id
integer
Created By
string
required
Numeric project ID (e.g., ‘12345’). This must be the integer ID as a string, not the project UUID or slug. To find the numeric ID, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint only works for projects with access control enabled (private projects). Access control is an Enterprise feature.
string
required
Parent Membership User Uuid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_PROJECT_PERSON_ACTIVITYRetrieve paginated person activity for a project, with optional JSON or CSV format, page, and limit parameters.

Input Parameters

integer
Page number of results to return (1-indexed).
integer
Number of results to return per page.
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Specify the session property key to find values for. Examples: $channel_type, $session_duration, $is_bounce, $entry_pathname, etc.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this subscription.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return. Use for pagination.
string ("csv" | "json")
Response format - csv or json. Default is json.
integer
Number of results to skip. Use for pagination.
string
Short ID of a specific saved insight to retrieve. This is the alphanumeric identifier that appears in the insight URL (e.g., ‘abc123’). If not provided, returns all trend insights for the project.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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_name

Input Parameters

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
A comma-separated list of event names to check for property association.
string
required
The property name to check if it has been seen together with the events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this property definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_SESSION_PROPERTY_DEFINITIONSRetrieve session property definitions for a specified project. Returns a page of definitions with pagination metadata.

Input Parameters

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this session recording.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The short ID of the session recording playlist to retrieve recordings from.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of results to return per page.
integer
The initial index from which to return the results.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this session recording.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this batch export.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this batch export run.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Batch Export Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID of the domain to retrieve. Domain IDs can be obtained from the list domains endpoint.
string
required
UUID of the PostHog organization that owns the domain. Found in organization settings or via the organizations API endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this exported asset.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Plugin Config Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this pipeline frontend app config.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this dashboard.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
integer
Page number of results to return (1-indexed).
integer
Number of results to return per page.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_RETRIEVE_SURVEY_RESPONSES_COUNT_BY_PROJECT_IDRetrieve survey response counts for a PostHog project, as a mapping from survey IDs to counts.

Input Parameters

string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID of the organization to retrieve export unsubscribe configurations for (e.g., ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’). Use POSTHOG_RETRIEVE_CURRENT_USER_PROFILE or POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The user identifier. Use ‘@me’ to retrieve the current authenticated user’s profile (recommended for non-staff users). Staff users can use an actual UUID to retrieve other users’ profiles. Non-staff users attempting to use a UUID other than ‘@me’ will receive a permission denied error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this batch export run.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
The BatchExport this run belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_REVERT_NOTEBOOK_WIDGETRevert notebook widget in a PostHog project. PostHog documents this notebook API as early access and subject to breaking changes.

Input Parameters

string
required
Stable identifier of the generated widget node.
string
required
Short id.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Earlier version to restore as a new version.
string
required
Current version used for optimistic concurrency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_REVOKE_ORGANIZATION_INVITEDelete an organization invite by its UUID. Requires a valid PersonalAPIKeyAuth with organization member write permission. No response body returned on success (HTTP 204).

Input Parameters

string
required
A UUID string identifying this organization invite.
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_ROLL_OUT_FEATURE_FLAG_TO_EVERYONERoll flag out to everyone in a PostHog project. Serve a feature flag to every user.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
required
The 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.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
The variant every user gets. Required for a multivariate flag and rejected for any other flag, because a release condition decides who the flag serves and not which variant they get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name for the endpoint to execute
boolean
Whether to include debug information (such as the executed HogQL) in the response.
integer
Maximum number of results to return. If not provided, returns all results.
string ("cache" | "force" | "direct")
Refresh mode for endpoint execution
integer
Specific endpoint version to execute. If not provided, the latest version is used.
object
Variables to parameterize the endpoint query. The key is the variable name and the value is the variable value. For HogQL endpoints: Keys must match a variable code_name defined in the query (referenced as {variables.code_name}). For non-materialized insight endpoints: date_from and date_to are built-in variables that filter the date range. For materialized insight endpoints: Use the breakdown property name as the key to filter by breakdown value. Unknown variable names will return a 400 error.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Client provided query ID. Can be used to retrieve the status or cancel the query.
object
Dashboard filter for overriding endpoint filters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Short id.
array
Replace the notebook’s variables with this list before the run starts, so the results match what the document declares. Omit it to run with the variables already saved.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Include prepared embedded insights when refreshing a dashboard widget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The node’s source — SQL for a hogql node, Python for a python node. Must not be blank.
object
Available upstream nodes, keyed by dataframe name. A SQL node inlines referenced hogql refs as CTEs — unless it references a local ref, which reroutes the run to the sandbox’s DuckDB; a python node materializes the hogql refs its code reads as pandas frames.
string
required
ProseMirror node id of the SQLV2 node being run.
string
required
Short id.
string ("hogql" | "python")
Execution kind. ‘hogql’ is a SQL node — pushed to ClickHouse, or rerouted to the sandbox’s DuckDB when it references a local frame; ‘python’ runs the code in the sandbox kernel, materializing referenced upstream nodes as pandas frames first. * hogql - hogql * python - python
array
Notebook-level variables in scope for this run. A SQL node has each {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.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Kernel nodes only: the dataframe variable to bind the result to in the kernel namespace (a python node falls back to the last expression for its preview).
string
SQL nodes only: id of a direct-query-capable external data source to run against instead of PostHog’s ClickHouse. Omit to query PostHog.
boolean
Reuse the requesting user’s running or completed HogQL run with the same cell and resolved query from the last hour. Does not apply to token-only callers, kernel runs, or connection runs.
boolean
Send the code to the selected connection verbatim instead of compiling it from HogQL first. Ignored without connection_id, and incompatible with references to other cells.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this signal report.
string ("get_it_merged" | "make_it_green" | "suggested_prompt" | "ask")
required
The action to run. Use a value from the actions list, or ask to send your own message. * get_it_merged - Get it merged * make_it_green - Make it green * suggested_prompt - Suggested prompt * ask - Ask
string
Your own request for the run. Required for ask, 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.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
Required for suggested_prompt: the suggested_prompt_index from the actions list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of ProseMirror step JSON objects to apply.
string
Updated notebook title.
string
required
The resulting ProseMirror document after applying the steps locally.
integer
required
The collab version the client’s steps are based on.
string
required
Short id.
string
required
Unique identifier for the client session.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
ProseMirror cursor head position after applying steps.
string
Plain text for search indexing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Updated title. Omit to preserve the title; an empty string clears it.
object
Optional author caret broadcast with the update; omit unused coordinates.
object
required
Full notebook document containing one {“type”:“ph-markdown-notebook”,“attrs”:{“markdown”:”…”}} node in its content array, usually with top-level type “doc”.
integer
required
Current notebook version from retrieval. A mismatched version returns HTTP 409 or 410; reload before retrying.
string
required
Notebook short_id, not its UUID.
string
required
Client session identifier used to skip self-echo on the update stream.
string
required
Project ID; list projects to find it.
string
Plain text for search indexing. Omitted defaults to empty on the provider, not the existing text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this feature flag.
string
required
The 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.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Zero-based position of the release condition in filters.groups, counted from the read that produced version.
number
required
Percentage of the users matching that condition who are served the flag, 0 through 100. On a multivariate flag this is how many matching users get a variant at all, not how the variants are split between them. Fractional percentages such as 0.5 are accepted, the same as a write that sends filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_SET_LLM_PROMPT_LABELSUpdate LLM prompt label in a PostHog project.

Input Parameters

integer
required
Prompt version this label should point to. If the label already exists on another version of the prompt, it is moved there.
string
required
Label name.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Prompt name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_SHIP_EXPERIMENT_VARIANTShip experiment variant in a PostHog project. Ship a variant and (optionally) end the experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string ("won" | "lost" | "inconclusive" | "stopped_early" | "invalid")
The conclusion of the experiment. * won - won * lost - lost * inconclusive - inconclusive * stopped_early - stopped_early * invalid - invalid
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
GitHub repository to open the cleanup pull request in, in organization/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.
string
required
The key of the variant to ship.
boolean
When true, open a draft pull request that removes the experiment’s feature-flag code from the linked repository. A personal API key needs the task:write scope (403 otherwise). Skipped when the conclusion is empty, or when no connected repository can be resolved.
string
Optional comment about the experiment conclusion.
boolean
If true, prepend a release condition to the feature flag that rolls the variant out to 100% of users, overriding any existing release conditions on the flag. If false (default), only update the variant distribution — existing release conditions are preserved and the variant is served only to users who already match them.
boolean
When true, also save 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_SPLIT_PERSON_ENTITIES_IN_PROJECTSplit distinct IDs from a person in a project. Optionally specify which distinct IDs to split off.

Input Parameters

string
required
A unique UUID value identifying this person.
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Distinct Ids to split off from this person. If not provided, all distinct IDs except one will be split.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID identifier for the symbol set (e.g., ‘550e8400-e29b-41d4-a716-446655440000’).
string
required
Git reference (branch, tag, or commit) for the symbol set (e.g., ‘main’, ‘v1.0.0’, ‘develop’).
string
required
Release version or identifier for the symbol set (e.g., ‘v1.0.0’, ‘1.2.3’).
integer
required
Team ID (also referred to as project ID in some contexts) associated with the symbol set.
string
ISO 8601 timestamp indicating when the symbol set was last used.
string
required
ISO 8601 timestamp indicating when the symbol set was created (e.g., ‘2026-02-16T10:00:00Z’).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Optional storage pointer reference for the symbol set location.
string
Optional reason for failure if the symbol set upload failed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UUID identifier for the symbol set being uploaded
string
required
Reference identifier (e.g., git branch name or commit ref) for the symbol set
string
required
Release version associated with the symbol set
integer
required
Team ID associated with the symbol set. Usually matches the project ID.
string
required
Chunk identifier for the upload session. Used to track individual file chunks during upload.
string
ISO 8601 timestamp indicating when the symbol set was last used for symbolication
string
required
ISO 8601 timestamp indicating when the symbol set was created
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Storage pointer for the symbol set data location
string
Optional reason for failure if the symbol set processing has failed previously

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
The index of the question to summarize responses for (0-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this feature flag.
string
Groups for feature flag evaluation (JSON object, defaults to empty dict)
string
Person ID to test against (mutually exclusive with distinct_id)
string
Optional point-in-time to evaluate the flag against — both flag conditions and person properties are reconstructed as they existed at that timestamp. ISO 8601 with timezone, e.g. 2026-04-29T15:30:00Z or 2026-04-29T15:30:00+00:00. Naive timestamps (no timezone) are interpreted as UTC.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
User distinct ID to test against (mutually exclusive with person_id)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_TEST_HOG_FUNCTION_INVOCATIONTest an unsaved Hog function with controlled inputs. Async functions such as fetch are always mocked so the test cannot perform their real external side effects.

Input Parameters

object
Mock global variables exposed to the invocation.
string
required
PostHog project ID.
object
required
Full unsaved Hog function configuration to test.
string
Optional invocation correlation ID.
object
Mock ClickHouse event data supplied to the invocation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_TEST_SAVED_HOG_FUNCTION_INVOCATIONTest a saved Hog function using a supplied configuration or its staged draft. Async functions are always mocked to prevent real external side effects.

Input Parameters

string
required
UUID of the saved Hog function to test.
object
Mock global variables exposed to the invocation.
boolean
Use the saved Hog function’s staged draft configuration.
string
required
PostHog project ID.
object
Hog function configuration to test. Required unless use_draft is true.
string
Optional invocation correlation ID.
object
Mock ClickHouse event data supplied to the invocation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The text to translate
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Target language code (e.g., ‘es’ for Spanish, ‘fr’ for French, ‘de’ for German)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Insight ID to export. Either dashboard or insight must be provided.
integer
Dashboard ID to export. Either dashboard or insight must be provided.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string ("image/png" | "application/pdf" | "text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
required
  • image/png - image/png * application/pdf - application/pdf * text/csv - text/csv * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
object
Export Context

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UNARCHIVE_EXPERIMENTUnarchive experiment in a PostHog project. Unarchive an archived experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UNARCHIVE_FEATURE_FLAGUnarchive feature flag in a PostHog project. Restore an archived feature flag to the default flag list.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UNARCHIVE_LLM_PROMPTUnarchive named LLM prompt in a PostHog project.

Input Parameters

string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Prompt name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
UUID string identifying the survey response to unarchive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UNFREEZE_EXPERIMENT_EXPOSUREUnfreeze experiment exposure in a PostHog project. Reopen enrollment on an exposure-frozen experiment.

Input Parameters

integer
required
A unique integer value identifying this experiment.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying the batch export to unpause
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UNPAUSE_ORGANIZATION_BATCH_EXPORTTool to unpause a paused batch export at the organization level. Use when you need to resume a previously paused organization-level batch export to restart data exports.

Input Parameters

string
required
A UUID string identifying the batch export to unpause
string
required
Organization ID of the organization containing the batch export

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this alert configuration.
string
required
Alert name. Maximum 255 characters.
object
Alert configuration settings
boolean
required
Whether the alert is enabled
integer
required
Insight ID monitored by this alert. The insight must exist in the same project.
object
Alert condition configuration
object
required
Alert threshold configuration defining when alert triggers
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Whether to skip checks during weekends
string
ISO 8601 timestamp until which the alert is snoozed
array
required
List of user IDs to subscribe to this alert. Can be an empty list if no users should be subscribed.
string
Calculation interval for the alert (can be string or object)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_ANNOTATION_DETAILSUpdate an existing annotation in a PostHog project by ID, including its content, date, scope, and deletion status.

Input Parameters

integer
required
A unique integer value identifying this annotation.
string ("dashboard_item" | "dashboard" | "project" | "organization")
  • dashboard_item - insight * dashboard - dashboard * project - project * organization - organization
string
Content
boolean
Deleted
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Updated At
string
Date Marker
integer
Dashboard Id
string
Insight Name
string ("USR" | "GIT")
  • USR - user * GIT - GitHub
integer
Dashboard Item
string
Dashboard Name
string
Insight Short Id
string
Insight Derived Name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_BATCH_EXPORTUpdate an existing organization-level batch export configuration in PostHog, including settings such as name, schedule, destination, or filtering options.

Input Parameters

string
required
A UUID string identifying the batch export to update
string
A human-readable name for this batch export
string
Which model this batch export is exporting (events, persons, or sessions)
string
Time after which batch export runs won’t be triggered (ISO 8601 datetime)
boolean
Whether this batch export is paused or not
object
Schema of custom fields to select when exporting data
object
Additional filters to apply to the exported data
string ("hour" | "day" | "week" | "every 5 minutes")
Batch export run interval options
string
Time before which batch export runs won’t be triggered (ISO 8601 datetime)
string
Timezone for scheduling the batch export
integer
Day offset for weekly exports (0=Sunday, 6=Saturday)
object
Batch export destination configuration
string
Custom HogQL query for filtering exported data
integer
Hour offset for daily exports (0-23)
string
required
The UUID of the organization containing the batch export

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_COHORT_REMOVE_PERSON_FROM_STATIC_COHORTRemove person from static cohort in a PostHog project.

Input Parameters

integer
required
A unique integer value identifying this cohort.
string
required
Person UUID to remove from the cohort
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this customer profile config.
string ("person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4")
required
Scope of the profile configuration (person or group_0 through group_4)
object
Content configuration for the customer profile. Can be any JSON object with arbitrary fields.
object
Sidebar configuration for the customer profile. Can be any JSON object with arbitrary fields.
string
required
ISO 8601 timestamp when the config was created. This field is required for PUT operations.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
ISO 8601 timestamp when the config was last updated. Optional for PUT operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this dashboard.
string
New markdown body for the text tile. Omit to leave the body unchanged. Max 4000 characters.
string
New accent color name, empty string or null to clear. Omit to leave unchanged.
string ("json" | "txt")
Format.
object
New grid layout per breakpoint. Omit to leave the layout unchanged. Object fields: {“sm”: {“type”: “object”, “description”: “Layout for the standard (desktop) breakpoint. The grid is 12 columns wide.”}, “xs”: {“type”: “object”, “description”: “Layout for the small (mobile) breakpoint. The grid is 1 column wide.”}}
integer
required
ID of the dashboard tile to update. Use dashboard-get to look up tile IDs.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Optional context that helps AI agents make consistent dashboard updates, such as Data Catalog metric names, data sources, tile-specific query assumptions, caveats, or editing guidance. PostHog’s Data Catalog is the semantic layer. Store canonical metric definitions there, not in this field. An empty string or null means there is no agent context. Shared and exported dashboards, and organizations without AI data processing approval, omit this field. Max 10000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this dashboard.
string ("json" | "txt")
Format.
array
required
Widget tiles to update atomically, each identified by its tile_id. config shape is per widget_type; see dashboard-widget-catalog-list for per-type config_schema (1–10 per request).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_DATASETTool to update a dataset in PostHog by its ID and project ID. Use when you need to modify the name or description of an existing dataset.

Input Parameters

string
required
A UUID string identifying the dataset to update
string
Name of the dataset (max 400 characters)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/
string
Description of the dataset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this dataset item.
object
Input data for the dataset item (e.g., prompt or question)
object
Output data for the dataset item (e.g., response or result)
string
required
UUID of the dataset this item belongs to
boolean
Whether the dataset item should be marked as deleted
object
Optional metadata associated with the dataset item
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Reference trace ID (max 255 characters)
string
Reference source ID (max 255 characters)
string
Reference timestamp (ISO 8601 datetime format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_DESKTOP_RECORDINGUpdate desktop meeting recording details via PATCH. Use to modify meeting title, notes, status, transcripts, or AI-extracted tasks and summaries. Requires desktop_recording:write scope.

Input Parameters

string
required
UUID of the desktop recording to update
string
Meeting notes or additional context
string ("recording" | "uploading" | "processing" | "ready" | "error")
Recording status.
string
AI-generated summary of the meeting
string ("zoom" | "teams" | "meet" | "desktop_audio" | "slack")
Meeting platform type.
string
URL to the video file (max 200 characters)
string
required
Project ID (environment ID) containing the recording. Find it via /api/projects/
string
ISO 8601 timestamp when the recording started
string
URL to the meeting (max 200 characters)
string
ISO 8601 timestamp when the recording was completed
array
List of participant names
string
Error message if processing failed
string
Title of the meeting (max 255 characters)
array
AI-extracted tasks from the transcript
string
Full transcript text
integer
Duration of the recording in seconds
integer
Size of the video file in bytes
string
ISO 8601 timestamp when tasks were generated
string
UUID of the associated Recall recording
array
Transcript segments with timestamps
string
ISO 8601 timestamp when the summary was generated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
Name
string ("draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived")
  • draft - draft * concept - concept * alpha - alpha * beta - beta * general-availability - general availability * archived - archived
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
string
Documentation Url

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL-safe name of the endpoint to update
object
Query configuration for the endpoint. Must include a ‘kind’ field specifying the query type (e.g., ‘HogQLQuery’, ‘TrendsQuery’, ‘FunnelsQuery’, etc.)
integer
Target a specific version for updates (optional, defaults to current version). Can also be passed as a query parameter ?version=N
boolean
Whether the endpoint is active and can be queried
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description for the endpoint to explain its purpose or usage
string ("5min" | "30min" | "1hour" | "6hour" | "12hour" | "24hour" | "7day" | "30day")
Sync frequency options for data warehouse endpoints
boolean
Whether this endpoint’s query results are materialized to S3 for faster access
number
Cache age in seconds for the endpoint. If set, responses will be cached for this duration to improve performance.
string
Insight ID from which this endpoint is derived, if applicable

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this error tracking auto capture controls.
string
required
Library identifier for error tracking configuration (e.g., ‘web’, ‘javascript’, ‘python’, ‘java’)
string ("all" | "any")
Match type for triggers: ‘all’ means all conditions must match, ‘any’ means at least one condition must match
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Sample rate for error tracking (decimal string format between -1.00 and 1.00, e.g., ‘0.90’ for 90%)
array
List of URL patterns that trigger error tracking
array
List of URL patterns to exclude from error tracking
array
List of event triggers that activate error tracking autocapture
string
Feature flag linked to this autocapture control (can be a string ID or a feature flag object)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_ERROR_TRACKING_ISSUEUpdate only the description of one PostHog error tracking issue.

Input Parameters

string
required
UUID of the error tracking issue to update.
string
required
PostHog project ID containing the error tracking issue.
string
required
Replacement issue description; may be blank.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this evaluation.
string
required
Name of the evaluation (max 400 characters)
boolean
Whether the evaluation is marked as deleted
boolean
Whether the evaluation is enabled
object
Conditions configuration for when the evaluation should run
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Optional description of what this evaluation does
string ("boolean")
required
Output type of the evaluation. Currently supported: ‘boolean’ (Boolean Pass/Fail)
object
Output configuration settings for how results are formatted
string ("llm_judge")
required
Type of evaluation. Currently supported: ‘llm_judge’ (LLM as a judge)
object
Configuration settings for the evaluation logic (e.g., prompt for LLM judge)
object
Model configuration for the evaluation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this event definition.
string
required
The name of the event definition.
array
Tags associated with this event definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Whether to post this event to Slack.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment.
string
Name
string
Filters
boolean
Archived
string
End Date
string
Created At
string
Parameters
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Start Date
string
Updated At
string
Description
integer
Exposure Cohort
string
required
Feature Flag Key (required for experiment update)
string
Secondary Metrics

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment holdout.
string
Name of the experiment holdout (max 400 characters).
array
Filter configuration for the experiment holdout (list of filter objects).
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the experiment holdout (max 400 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment holdout.
string
required
Name of the experiment holdout (max 400 characters).
array
required
List of filter configurations for the holdout. At least one filter with properties and rollout_percentage is required.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the experiment holdout (max 400 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this experiment saved metric.
string
required
Name of the experiment saved metric.
array
Tags associated with the experiment saved metric.
object
required
Query configuration for the experiment metric. Must contain ‘kind’ field (e.g., ‘ExperimentTrendsQuery’) and a ‘count_query’ with series definition.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the experiment saved metric.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_EXTERNAL_DATA_SCHEMAPartially update an external data schema’s sync configuration.

Input Parameters

string
required
External data schema UUID.
string ("full_refresh" | "incremental" | "append" | "webhook" | "cdc" | "xmin")
Sync strategy for this schema.
string
required
PostHog project ID.
string
Vendor API version override, or null to use the source version.
array
Source-row predicates joined with AND; null or an empty list clears them.
boolean
Whether PostHog should sync this schema.
string ("consolidated" | "cdc_only" | "both")
Output mode for a CDC schema, or null.
string ("never" | "5min" | "15min" | "30min" | "1hour" | "6hour" | "12hour" | "24hour" | "7day" | "30day")
How often PostHog should sync the schema, or null.
array
Source columns to sync; null syncs every column.
string
UTC sync time in HH:MM:SS format, or null.
string
Column used to track incremental sync progress, or null to clear it.
array
Columns used as the primary key, or null to clear them.
string ("integer" | "numeric" | "datetime" | "date" | "timestamp" | "objectid" | "xid")
Data type of the incremental field, or null to clear it.
string
UTC full-refresh time in HH:MM:SS format, or null.
integer
Days between full refreshes, from 1 through 90, or null.
integer
Incremental overlap window in seconds, from 0 through 5184000, or null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this external data source
string
required
Account ID for the external data source (e.g., Stripe account ID)
object
Additional job input parameters for the data source
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the external data source (max 400 characters)
string
required
Client secret or API key for authenticating with the external data source
object
Revenue analytics configuration for the data source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_FEATURE_FLAGUpdate the configuration of a specific feature flag in a PostHog project using its ID and key.

Input Parameters

integer
required
A unique integer value identifying this feature flag.
string
required
Key
string
contains the description for the flag (field name name is kept for backwards-compatibility)
array
Tags
boolean
Active
boolean
Deleted
object
Filters
object
Surveys
boolean
Can Edit
object
Features
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
array
Experiment Set
boolean
Is Simple Flag
integer
Usage Dashboard
boolean
Performed Rollback
integer
Rollout Percentage
string
Rollback Conditions
array
Analytics Dashboards
boolean
Has Enriched Analytics
boolean
Ensure Experience Continuity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this file system.
string
Reference identifier for the file system (max 100 characters)
string
URL reference to the file system resource
object
Additional metadata associated with the file system resource
string
required
Path of the file system resource
string
Type of the file system resource (max 100 characters)
integer
Depth level of the file system resource in the hierarchy
boolean
Whether this file system resource is a shortcut
string
required
ISO 8601 timestamp of when the file system was created
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
ISO 8601 timestamp of when the file system was last viewed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_GROUP_PROPERTYUpdate group property in a PostHog project.

Input Parameters

string
required
Name of the property to set.
string
required
Value to set. Any JSON value other than null.
string
required
Specify the key of the group to find
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Specify the group type to find

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this group usage metric
string
required
Name of the group usage metric
string ("numeric" | "currency")
Format options for group metrics
string ("number" | "sparkline")
Display format options for group metrics
object
required
Filter configuration for the group usage metric
integer
Interval in days for the metric calculation
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
integer
required
Numerical identifier for the group type (e.g., 0, 1, 2). Used to differentiate between different types of groups such as companies, projects, or teams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this hog function.
string
Hog code for the function
string
Name of the hog function (max 400 characters)
string
Type of the hog function
object
Input values for the hog function with bytecode, order, templating, transpiled, and value properties
boolean
Whether the hog function is marked as deleted (soft delete)
boolean
Whether the hog function is enabled
object
Filter configuration for the hog function including actions, events, properties, and source
object
Masking configuration with hash, ttl, bytecode, and threshold properties
string
URL of the icon for the hog function
array
Mappings configuration for the hog function with filters, inputs, inputs_schema, and name properties
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description of the hog function
string
Template ID (max 400 characters)
array
Schema defining the inputs for the hog function with key and type as required fields
string
UUID of the associated batch export
integer
Execution order of the hog function (0-32767)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this insight variable.
string
required
Name of the insight variable (max 400 characters)
string ("String" | "Number" | "Boolean" | "List" | "Date")
required
Type of the insight variable (String, Number, Boolean, List, or Date)
string
Possible values for the insight variable (for List type variables)
string
required
Code name for the insight variable, used for programmatic access
string
ISO 8601 timestamp when the insight variable was created
integer
ID of the user who created the insight variable
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Default value for the insight variable. Type depends on the ‘type’ field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this live debugger breakpoint
boolean
Whether the breakpoint is enabled. If true, the breakpoint will be active
string
required
The filename where the breakpoint is set
string
Optional condition expression for the breakpoint. The breakpoint will only trigger when this condition evaluates to true
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/
string
Optional repository identifier where the file is located
integer
required
The line number where the breakpoint is set. Must be non-negative

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Sequential find/replace operations on the current prompt. Each old text must match exactly once. Mutually exclusive with prompt.
object
Versioned model or agent configuration. Omit to carry forward the current config; pass null to clear it. Can accompany prompt or edits. Do not store secrets: readers can see this config.
string
Full prompt payload as JSON or string data. Mutually exclusive with edits.
string
required
PostHog project ID containing the prompt.
string
required
Name of the existing prompt to publish a new version of.
integer
Latest version being edited, for optimistic concurrency checks.
string
Note describing this version, shown in version history; at most 400 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The caller’s caret position, broadcast to other clients on this notebook’s collab stream. Object fields: {“head”: {“type”: “integer”, “description”: “ProseMirror selection head position (rich v1 notebooks).”}, “node_index”: {“type”: “integer”, “description”: “Index of the caret’s block node in the markdown notebook document (markdown notebooks).”}, “offset”: {“type”: “integer”, “description”: “Caret offset in the plain text of the focused editable element, in UTF-16 code units.”}, “list_item_index”: {“type”: “integer”, “description”: “Index of the focused list item when the caret is inside a list block.”}}
integer
required
The notebook version the cursor position is relative to.
string
required
Short id.
string
required
Unique identifier for the client session, used to skip self-echo on the update stream.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_ORGANIZATIONUpdate specific details of an organization using its UUID. Requires organization:write permission and returns updated organization information.

Input Parameters

string
required
Id
string
Name
string
Slug
array
Teams
string
Metadata
string
Created At
string
Updated At
string
Customer Id
boolean
Enforce 2Fa
string
Member Count
array
Available Product Features
boolean
Is Member Join Email Enabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying the batch export to update
string
required
A human-readable name for this batch export
string
Which model this batch export is exporting (events, persons, or sessions)
string
Time after which batch export runs won’t be triggered (ISO 8601 datetime)
boolean
Whether this batch export is paused or not
object
Schema of custom fields to select when exporting data
object
Additional filters to apply to the exported data
string ("hour" | "day" | "week" | "every 5 minutes")
required
How frequently the batch export runs (hour, day, week, or every 5 minutes)
string
Time before which batch export runs won’t be triggered (ISO 8601 datetime)
string
Timezone for scheduling the batch export
integer
Day offset for weekly exports (0=Sunday, 6=Saturday)
object
required
The destination configuration where data will be exported
string
Custom HogQL query for filtering exported data
integer
Hour offset for daily exports (0-23)
string
required
The UUID of the organization containing the batch export

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_ORGANIZATION_BY_UUIDPUT /api/organizations/{id}/: Update organization details by providing a UUID as ‘id’. Supports JSON, form-urlencoded, multipart/form-data. Requires ‘organization:write’ permission. Returns updated organization data.

Input Parameters

string
required
A UUID string identifying this organization.
string
required
Name of the organization (required).
string
Slug
boolean
Enforce 2Fa
boolean
Is Member Join Email Enabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 rotation

Input Parameters

string
required
A UUID string identifying the domain to update.
string
required
The domain name (e.g., ‘example.com’) to be used for authentication. Must be a verified domain.
string
The SAML Assertion Consumer Service (ACS) URL from your SAML identity provider. This is the URL where SAML assertions are sent after successful authentication.
string
The SAML Entity ID (also known as Issuer) from your SAML identity provider. This uniquely identifies your SAML IdP.
string
The X.509 certificate from your SAML identity provider, used to verify SAML assertions. Provide the certificate in PEM format.
string
required
The UUID of the organization that owns this domain.
string
SSO enforcement policy for this domain. When set, users with email addresses on this domain will be required to use the specified SSO provider. Common values include SAML provider identifiers or authentication method names.
boolean
Enable just-in-time (JIT) user provisioning. When true, new user accounts are automatically created when a user logs in via SSO with an email matching this verified domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Membership access level to set for this user. Valid values: 1 (member with basic access), 8 (admin with elevated permissions), 15 (owner with full control). Use this to promote/demote members.
string
required
UUID of the user whose organization membership you want to update. You can get this by listing organization members.
string
required
UUID of the organization containing the member to update. You can get this from the current user profile or by listing organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_ORGANIZATION_MEMBER_COMPLETEUpdate member details in an organization by organization ID and user UUID. Requires organization member write permission and returns member information, including role and security settings.

Input Parameters

string
required
Id
string
required
Joined At
string
required
Updated At
string
required
User Uuid
boolean
required
Is 2Fa Enabled
boolean
required
Has Social Auth
string
required
Organization Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID of the proxy record to update. Example: ‘019c0f36-94ac-0000-0fa9-137ee5d79c7e’
string
The custom domain name for the proxy record (e.g., ‘analytics.yourdomain.com’). NOTE: Changing the domain may require DNS reconfiguration.
string
The status of the proxy record. Possible values: ‘waiting’ (awaiting DNS verification), ‘issuing’ (SSL certificate being provisioned), ‘live’ (fully operational). This field is typically managed by PostHog and should not be manually updated.
string
Additional status message or error information about the proxy record.
string
ISO 8601 timestamp when the proxy record was created (read-only).
integer
User ID of the person who created the proxy record (read-only).
string
ISO 8601 timestamp when the proxy record was last updated (read-only).
string
The PostHog CNAME target (read-only, managed by PostHog). This field typically should not be updated manually.
string
required
The UUID of the organization that owns the proxy record. Example: ‘019c0f24-2413-0000-bbbc-d276c57e0dbb’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_ORGANIZATION_ROLEUpdate an organization role’s name and optionally its feature flag access level by specifying the organization and role IDs. Returns updated role data and requires organization write access.

Input Parameters

string
required
A UUID string identifying this role.
string
required
Name of the role to update
string
required
Organization Id
integer
Feature flags access level for the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying the Persisted Folder to update
string
File system path for the persisted folder
string ("home" | "pinned" | "custom_products")
required
Type of the persisted folder (home, pinned, or custom_products)
string
Protocol prefix for the folder (max 64 characters)
string
required
ISO 8601 timestamp when the folder was created
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
ISO 8601 timestamp when the folder was last updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
Name
string
Uuid
string ("csv" | "json")
Format
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Properties
array
Distinct Ids

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_PERSON_PROPERTYRequest an update to a specific property of a person in a PostHog project using a property key and value.

Input Parameters

string
required
A unique UUID value identifying this person.
string
required
Specify the property key
string
required
Specify the property value
string ("csv" | "json")
Format
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this product tour.
string
required
Name of the product tour (maximum 400 characters).
object
Content configuration for the product tour.
boolean
Whether the product tour is archived.
string
End date for the product tour in ISO 8601 format.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Start date for the product tour in ISO 8601 format.
boolean
Whether the product tour should auto-launch.
string
Description of the product tour.
object
Targeting flag filters for the product tour, excluding base exclusion properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this action.
string
Name
array
Tags
array
Steps
string ("csv" | "json")
Format
boolean
Deleted
integer
Team Id
boolean
Is Action
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
boolean
Post To Slack
string
Bytecode Error
boolean
Is Calculating
string
Last Calculated At
string
Slack Message Format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying the batch export to update
string
required
A human-readable name for this batch export
string ("events" | "persons" | "sessions")
Batch export model types
string
ISO 8601 timestamp - time after which batch export runs won’t be triggered
boolean
required
Whether this batch export is paused or not
object
A schema of custom fields to select when exporting data
object
Filter configuration to specify which data to export
string ("hour" | "day" | "week" | "every 5 minutes")
required
Export frequency/interval for the batch export (hour, day, week, or every 5 minutes)
string
ISO 8601 timestamp - time before which batch export runs won’t be triggered
string
Timezone for scheduling the batch export (e.g., UTC, America/New_York)
integer
Day offset for weekly exports (0=Sunday through 6=Saturday)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/
object
required
Destination configuration for where data is exported
string
HogQL query string for filtering or transforming exported data
integer
Hour offset for daily exports (0-23)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this cohort.
string
Name
string
Query
string
Groups
boolean
Deleted
string
Filters
boolean
Is Static
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this dashboard.
string
Name
array
Tags
array
Tiles
boolean
Pinned
boolean
Deleted
string
Filters
boolean
Is Shared
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
string
Use Template
integer
Use Dashboard
boolean
Delete Insights

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this early access feature.
string
required
Name
string ("draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived")
  • draft - draft * concept - concept * alpha - alpha * beta - beta * general-availability - general availability * archived - archived
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
string
Documentation Url

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this event definition.
string
The name of the event definition.
array
Tags associated with this event definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
boolean
Whether to post this event to Slack.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Group Type
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Name Plural
string
Name Singular
integer
Group Type Index

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id
string
Name
array
Tags
string
Hogql
integer
Order
string
Query node JSON string
boolean
Saved
string
Types
string ("csv" | "json")
Format
string
Result
string
Columns
boolean
Deleted
string
Filters
string
Short Id
string
The timezone this chart is displayed in.
boolean
Favorited
string
Is Cached
boolean
Is Sample
string
Created At
array
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Updated At
string
Description
string
Derived Name
string
The datetime this insight”s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
string
Query Status
array
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
string
The target age of the cached results for this insight.
string
Last Modified At
string
The earliest possible datetime at which we”ll allow the cached results for this insight to be refreshed by querying the database.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The access level for the member. Common values: 1 (member), 8 (admin).
string
required
Project ID of the project you are trying to access. To find the ID of the project, make a call to /api/projects/. Note: This endpoint only works for projects with access control enabled (private projects).
integer
The effective access level for the member (read-only, computed from multiple sources).
string
required
The UUID of the user whose membership is being updated (from organization membership).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Title
string
Content
boolean
Deleted
integer
Version
string
required
Short Id of the notebook
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Text Content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this property definition.
string
required
The name of the property definition.
array
List of tags associated with the property definition.
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
The type of property. Possible values include: ‘Boolean’, ‘Numeric’, ‘String’, ‘DateTime’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Id
string
Name
boolean
Pinned
boolean
Deleted
string
Filters
string
required
Short Id
string
required
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Description
string
Derived Name
string
required
Last Modified At

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_PROJECT_SETTINGSTool to update project settings and configuration within a PostHog organization. Use when you need to modify project properties such as timezone, feature toggles, or recording settings.

Input Parameters

integer
required
A unique value identifying this project. This is the project ID (integer) not UUID.
string
Project name.
array
List of application URLs for this project.
string
Project timezone (e.g., ‘UTC’, ‘America/New_York’).
boolean
Whether to anonymize IP addresses in data collection.
boolean
Whether surveys are enabled.
boolean
Whether heatmaps are enabled.
boolean
Whether to inject web apps.
string
required
Organization UUID or ID containing the project.
integer
Primary dashboard ID for this project.
array
List of domains for session recording.
boolean
Whether autocapture is disabled for this project.
string
Product description (max 1000 characters).
string
Slack incoming webhook URL for notifications.
boolean
Whether session recording is enabled.
boolean
Whether console log capture is enabled.
boolean
Whether performance capture is enabled.
boolean
Whether snippet onboarding has been completed.
boolean
Whether exception autocapture is enabled.
boolean
Whether web vitals autocapture is enabled.
string
Session recording sample rate (e.g., ‘1.0’ for 100%).
array
List of person properties to use for display names.
boolean
Whether test account filters are checked by default.
integer
Minimum session duration in milliseconds to record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this subscription.
integer
Count
string
Title
boolean
Deleted
integer
Insight
integer
Bysetpos
integer
Interval
array
Byweekday
integer
Dashboard
string ("daily" | "weekly" | "monthly" | "yearly")
required
  • daily - Daily * weekly - Weekly * monthly - Monthly * yearly - Yearly
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Start Date
string
Until Date
string ("email" | "slack" | "webhook")
required
  • email - Email * slack - Slack * webhook - Webhook
string
required
Target Value
string
Invite Message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this survey.
string
required
Name
string ("popover" | "widget" | "button" | "email" | "full_screen" | "api")
required
  • popover - popover * widget - widget * button - button * email - email * full_screen - full screen * api - api
boolean
Archived
string
End Date
string
The array of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice. Basic (open-ended question) - type: open - question: The text of the question. - description: Optional description of the question. - descriptionContentType: Content type of the description (html or text). - optional: Whether the question is optional (boolean). - buttonText: Text displayed on the submit button. - branching: Branching logic for the question. See branching types below for details. Link (a question with a link) - type: link - question: The text of the question. - description: Optional description of the question. - descriptionContentType: Content type of the description (html or text). - optional: Whether the question is optional (boolean). - buttonText: Text displayed on the submit button. - link: The URL associated with the question. - branching: Branching logic for the question. See branching types below for details. Rating (a question with a rating scale) - type: rating - question: The text of the question. - description: Optional description of the question. - descriptionContentType: Content type of the description (html or text). - optional: Whether the question is optional (boolean). - buttonText: Text displayed on the submit button. - display: Display style of the rating (number or emoji). - scale: The scale of the rating (number). - lowerBoundLabel: Label for the lower bound of the scale. - upperBoundLabel: Label for the upper bound of the scale. - branching: Branching logic for the question. See branching types below for details. Multiple choice - type: single_choice or multiple_choice - question: The text of the question. - description: Optional description of the question. - descriptionContentType: Content type of the description (html or text). - optional: Whether the question is optional (boolean). - buttonText: Text displayed on the submit button. - choices: An array of choices for the question. - shuffleOptions: Whether to shuffle the order of the choices (boolean). - hasOpenChoice: Whether the question allows an open-ended response (boolean). - branching: Branching logic for the question. See branching types below for details. Branching logic can be one of the following types: Next question: Proceeds to the next question json { "type": "next_question" } End: Ends the survey, optionally displaying a confirmation message. json { "type": "end" } Response-based: Branches based on the response values. Available for the rating and single_choice question types. json { "type": "response_based", "responseValues": { "responseKey": "value" } } Specific question: Proceeds to a specific question by index. json { "type": "specific_question", "index": 2 }
string
Appearance
string
Conditions
string
Created At
string
required
Project ID of the project you”re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Start Date
string
Description
integer
Linked Flag Id
integer
Iteration Count
integer
Responses Limit
integer
Current Iteration
array
Iteration Start Dates
integer
Iteration Frequency Days
string
Current Iteration Start Date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
List of tab configurations to update
string
required
UUID of the user to update home settings for. Use ‘@me’ to update settings for the authenticated user.
object
Homepage configuration for the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A UUID string identifying this data warehouse saved query.
string
required
Name for the warehouse saved query. Maximum length is 128 characters.
object
required
HogQL query object containing the query kind and query string to execute
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
UUID of the edited history record. This tracks the edit lineage of the saved query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
A unique integer value identifying this web experiment.
string
required
Name of the web experiment (max 400 characters)
object
required
Variants configuration for the web experiment. Keys are variant names (e.g., ‘control’, ‘test’), values are variant configurations with transforms and rollout percentages
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
required
Feature flag key to associate with this web experiment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTHOG_UPDATE_WORKFLOW_ACTIONS_EMAILUpdate workflow email action in a PostHog project.

Input Parameters

string
required
A UUID string identifying this hog flow.
string
required
Id of the function_email step to edit.
array
Ordered design edits applied atomically to this step’s email design - the same operations as the email template patch. The result is re-rendered to HTML server-side, so the sent email always matches the patched design.
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
string
Partial email fields deep-merged into the step’s email (a null leaf deletes the key): subject, preheader, text, to, from, replyTo, cc, bcc. The sender is from: {integrationId, email?, name?}, where email and name are optional templated overrides resolved per invocation; the address must resolve to the selected sender’s verified domain or the send fails. The design is edited via operations, and html is always re-rendered from it.
string
Optimistic concurrency: the updated_at (or draft_updated_at) last loaded. If the stored workflow is newer, the patch is rejected with 409 instead of clobbering a concurrent edit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
API key to validate for the specified LLM provider
string
required
LLM provider name (e.g., ‘openai’, ‘anthropic’, ‘google’)
string
required
Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: 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

array
required
The saved PostHog Actions to fire on, by id. Pass one or more. Use POSTHOG_LIST_PROJECT_ACTIONS to find ids. At least one is required.
boolean
When true, PostHog drops events from the project’s configured internal and test users before this trigger fires. Leave unset to receive everything.
integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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

array
required
The analytics events to fire on, by name. Pass one or more. Only these events are delivered; PostHog applies the filter before it calls the webhook, so nothing else reaches you or counts against your PostHog usage. To follow a set of events that is defined by rules rather than by name, define a PostHog Action and use the Action Performed trigger instead.
boolean
When true, PostHog drops events from the project’s configured internal and test users before this trigger fires. Leave unset to receive everything.
integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.
Slug: 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.

Configuration

integer
required
The PostHog project (PostHog calls it a Team) to watch. A personal API key can span projects and the connection names none, so this is required. Use POSTHOG_LIST_ALL_PROJECTS_ACROSS_ORGANIZATIONS to list your project ids.

Payload

object
required
The PostHog event this delivery carries.
object
The PostHog person the event is about.
object
required
The project the event happened in.