PrecisionBook a discovery call
Menu

PostHog for AI agents

Agents read PostHog at once. Changes and sends are held for a person's approval by default.

Book a discovery callBrowse all connectors

About PostHog

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

What an agent can do in PostHog

Every PostHog action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.

Runs at once (reads)

Looks things up in PostHog without asking first. 263 actions.

  • List projects in organization with paginationProjects for the current organization.
  • List project group types by idList 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 typ
  • 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
  • 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. Requ
  • 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 t
  • Check project's 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
  • 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.
  • 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.
  • Retrieve app metrics by idsRetrieve 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
  • Retrieve app metrics error detailsRetrieves detailed error information for a specific app metric (plugin config) within a project. This endpoint provides error details for plugins/apps that have experienced failures. If the plugin con
  • Retrieve 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, inter
  • Get billing detailsRetrieve billing and subscription details for the connected PostHog account. Use this to inspect plan status, totals, discounts, and available product features.
Show all 263
  • Retrieve cohort activity detailsRetrieve activity details for a specific cohort within a project. Requires a project ID and cohort ID, returning status, filters, query, and creator data. Auth: PersonalAPIKeyAuth with 'activity_log:r
  • Retrieve 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.
  • Get cohort 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 o
  • 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.
  • 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.
  • 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.
  • 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.
  • Retrieve dashboard template details by uuidFetch specific dashboard template details by UUID in a project with 'dashboard_template:read' rights using a PersonalAPIKeyAuth. Returns name, description, filters, and creation info.
  • Retrieve 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
  • 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.
  • 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, creat
  • Get dataset detailsRetrieve detailed information about a specific dataset within a project. Use this to get dataset properties including name, description, creator info, and timestamps.
  • 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 inform
  • 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.
  • 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.
  • 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 suppo
  • 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
  • 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. Support
  • 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
  • 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 finge
  • 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 pagi
  • 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.
  • 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.
  • 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.
  • 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 pa
  • Get error tracking symbol setsTool to retrieve error tracking symbol sets for a PostHog project. Use when you need to list symbol sets used for error stack trace symbolication. Returns paginated list of symbol sets including their
  • 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.
  • Get evaluations for projectTool 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 searc
  • Retrieve event definition by uuidRetrieve 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_
  • Get event definition by nameTool to retrieve an event definition by its exact name for a specific project. Use when you need to look up details about a specific event by name rather than UUID.
  • Retrieve event definitions by project idRetrieve definitions for events within a specified project by providing the unique project_id. Requires PersonalAPIKeyAuth privileges for event_definition:read. No response body provided upon a succes
  • Get event definitions in Golang formatTool 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.
  • Get event definitions in Python formatTool 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.
  • 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.
  • Retrieve experiment details by idsAccess 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.
  • 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.
  • 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
  • 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.
  • Get eligible feature flags for experimentsTool 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 wher
  • Retrieve 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
  • Get experiments statsTool to retrieve experimentation velocity statistics for a PostHog project. Use when you need to understand overall experiment activity and distribution. Returns high-level statistics including total,
  • Retrieve 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 impo
  • Fetch 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
  • Get external data schemaRetrieve one external data schema and its sync configuration.
  • 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.
  • 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.
  • Retrieve feature flag activity detailsManage feature flags (creation, reading, updating, and deleting) using PostHog's guides or via JavaScript Library/endpoint for user-specific flag status. [Details](https://posthog.com/docs/user-guides
  • Retrieve 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 ro
  • Retrieve 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.
  • Retrieve feature flags activity logLearn to manage feature flags by creating, reading, updating, and deleting them. Use PostHog's JavaScript Library or endpoint for application integration. Details in the [docs](https://posthog.com/doc
  • 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 show
  • Retrieve feature flags evaluation reasonsManage feature flags—create, read, update, delete—using the PostHog JavaScript Library or endpoint for user-specific flag status. (More in docs).
  • Get feature flags matching IDsTool to get IDs of all feature flags matching the current filters. Uses the same filtering logic as the list endpoint and returns only IDs that the user has permission to edit.
  • 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.
  • 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.
  • 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 tim
  • Retrieve 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.
  • Retrieve funnel insights in projectExecute a funnel analysis for a specific project. Requires specifying funnel steps via 'events' or 'actions' parameter (at least 2 steps). Returns conversion data showing how users progress through th
  • Retrieve group property definitions by project idRetrieve property definitions for a group within a project by providing the project ID. This endpoint returns details like group type index, key, and creation time in JSON format.
  • Retrieve group property values by index and keyRetrieve property values by 'group_type_index' and 'key' within a 'project_id'. Parameters must be provided. Output is a JSON with property details and creation timestamp.
  • Get group type 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 metr
  • 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 conf
  • Retrieve hedgehog configuration by uuidRetrieve 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
  • Retrieve 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.
  • 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.
  • Get Hog function metric totalsRead aggregate execution metric totals for a PostHog Hog function.
  • 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.
  • Retrieve 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, fe
  • Retrieve 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 token
  • Get insight 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 thres
  • 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.
  • 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.
  • 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, de
  • 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.
  • 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
  • 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
  • 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 mas
  • 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
  • Get logs availability statusTool 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.
  • Get log field 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.
  • Fetch organization details by uuidRetrieve organization details by UUID. Endpoint requires 'organization:read' access. Response includes name, slug, timestamps, membership, plugins access level, and team structure.
  • Fetch 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', 's
  • Get persisted foldersTool 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.
  • Fetch pipeline destination activityRetrieve 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
  • Fetch 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-ti
  • 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.
  • Retrieve and delete project person trendsThis endpoint is for reading and deleting persons. Use the capture API, `$set`/`$unset` properties, or SDKs for creating/updating persons.
  • Fetch project survey activity logRetrieve the activity log of surveys within a specific project by using the project ID. This endpoint requires a PersonalAPIKeyAuth with 'activity_log:read' permission and returns survey details inclu
  • 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 th
  • 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.
  • Fetch 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 m
  • 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.
  • 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.
  • 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.
  • 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
  • Retrieve unused organization 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 deta
  • 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.
  • 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.
  • Get warehouse saved queries activityTool to retrieve activity details for a specific warehouse saved query in PostHog. Use when you need to check the execution history, status, and metadata of a data warehouse saved query.
  • Get warehouse saved queryTool to retrieve a warehouse saved query from PostHog data warehouse. Use when you need to get details about a specific saved query including its status, execution history, and configuration. Returns
  • Get warehouse tableRetrieve details of a specific data warehouse table by its UUID. Use this to inspect warehouse table configuration, credentials, schema, and format.
  • 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 se
  • 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.
  • 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 (Cumulativ
  • List alerts for projectTool 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
  • List all projects across organizationsTool to list all projects the authenticated user can access by enumerating organizations and aggregating each organization's projects. Use when you need to discover all available projects without know
  • List and manage project annotationsCreate, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
  • 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/surv
  • 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 timestam
  • List conversations ticketsTool to list tickets with person data attached for a project. Use when you need to retrieve all tickets in a project, with optional pagination support.
  • List dashboard sharing configsRetrieve a list of dashboard sharing configurations for a specified project and dashboard. Requires dashboard ID, project ID, and sharing read permission via PersonalAPIKeyAuth. Returns JSON array of
  • List endpoints for projectTool to list all endpoints for the team. Use when you need to retrieve or discover available endpoints within a project.
  • List endpoint versionsTool to list all versions for a specific endpoint in PostHog. Use when you need to retrieve version history or check available versions for an endpoint. Requires both the project ID and the endpoint n
  • 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
  • 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.
  • 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.
  • List file system resourcesTool 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.
  • List specific type groups with paginationList all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/
  • 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
  • List active live debugger breakpointsTool to fetch active live debugger breakpoints for external client applications using Project API key. Returns a list of breakpoints that client applications can use to instrument their code according
  • List notebooks with filters and paginationThe API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  • List or delete persons with optional filtersThis endpoint is for reading/deleting persons. For creating/updating, use the capture API, set/unset properties, or SDKs.
  • List organization s batch exports with paginationRetrieve paginated batch exports for an organization, with filters and optional limits. Includes team, interval, and status details. Access requires PersonalAPIKeyAuth with batch_export:read rights.
  • List organization domains with paginationFetch 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, v
  • 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 inte
  • List organization invites with paginationRetrieve 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
  • List organization members with paginationList 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
  • List organization s pipeline destinationsRetrieve a paginated list of an organization's pipeline destinations by ID, with optional count and offset parameters. Requires PersonalAPIKeyAuth (plugin:read). Returns details like ID, type, and org
  • List Organization's 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
  • List organization s 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 UU
  • List organization s pipeline transformationsRetrieve paginated pipeline transformation lists for an organization using `limit` and `offset`, requiring a UUID and PersonalAPIKeyAuth. Supports filtering and detailed views.
  • List Organization Plugins with PaginationRetrieve 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. Retu
  • 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 dom
  • List organization roles with paginationList 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
  • List pipeline destination configs with paginationList 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. Auth
  • 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 l
  • 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 fi
  • List project actions with pagination and filtersGet paginated project actions with filters by format. Query params: limit, offset. Needs PersonalAPIKeyAuth for read. Includes ID, name, description, metadata.
  • List project batch exports with paginationRetrieve 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.
  • 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
  • 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
  • List project dashboards with paginationGet paginated dashboards for a project by ID, using 'limit' and 'offset'. Must authenticate with PersonalAPIKeyAuth. Includes count, pagination, and dashboard details.
  • 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
  • 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
  • List project experiments with paginationGet 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.
  • List project export items with paginationRetrieve 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 ex
  • 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 endp
  • 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
  • ListprojectpipelineimportconfigsList 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 ob
  • 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 en
  • 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 c
  • List project subscriptions with paginationRetrieve 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
  • List paginated surveys for a projectGet paginated surveys for a project with its ID, using 'limit' and 'offset'. Needs PersonalAPIKeyAuth ('survey:read'). JSON output includes survey info, links, and metadata.
  • List Role Memberships PaginatedList 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 ha
  • List of project s 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.). Ses
  • 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.
  • List signal reportsList signal reports for a PostHog project with filters and pagination.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
  • 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, visua
  • Post Project Trends With FiltersThe `/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
  • Query logsQuery project logs using typed filters and cursor pagination.
  • Retrieve async query status by id(Experimental)
  • Retrieve last viewed insights for userReturns basic details about the last 5 insights viewed by this user. Most recently viewed first.
  • Retrieve matching events for session recordingRetrieves event IDs matching a filter with one session ID and at least one event/action criterion. Intended for internal use and may have sudden changes. IMPORTANT: This endpoint does NOT support Pers
  • Retrieve notebook activity for projectThe API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  • Retrieve notebook activity logThe API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  • Retrieve notebook detailsThe API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  • Retrieve or delete person retention dataThis endpoint is for reading and deleting person data; use the capture API, `$set`/`$unset` properties, or SDKs for creation and updates.
  • 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 retu
  • Retrieve organization pipeline frontend app detailsRetrieve 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.
  • Retrieve Org Pipeline Repo 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.).
  • Retrieve org pipeline transformation activityRetrieve org pipeline transformation activity
  • 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., noti
  • Retrieve organization plugin activityRetrieve activity details for plugins in a specified organization by ID. Supports various plugin types, including local, custom, and repository. Response includes plugin's id, name, type, and relevant
  • 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. Respond
  • 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/repo
  • 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
  • Retrieve organization project detailsProjects for the current organization.
  • 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:re
  • Retrieve organization s 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.
  • 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 contr
  • 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.
  • Retrieve person s activity and delete optionsThis endpoint is for reading and deleting persons; for creating/updating, use the capture API, `$set`/`$unset` properties, or SDKs.
  • Retrieve person details by idThis endpoint is used to read and delete persons. For creating or updating, use the capture API, `$set` and `$unset` properties, or SDKs.
  • Retrieve person property valuesRetrieve 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 v
  • Retrieve pipeline destination activityRetrieve activity details for pipeline destinations within an organization. **Parameters:** - `organization_id` (required): UUID-formatted organization identifier **Returns:** JSON object with pipelin
  • 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 det
  • 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.
  • Retrieve pipeline destination plugin detailsRetrieve details of a specific pipeline destination plugin within an organization by its unique ID. The response includes various properties like name, description, URL, and plugin type for the given
  • Retrieve pipeline frontend app activityRetrieve activity details for pipeline front-end apps within a specified organization by organization ID. Returns JSON object with app properties such as ID, type, name, and configuration. UUID path p
  • 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 b
  • 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
  • Retrieve pipeline frontend plugin configRetrieve the frontend-specific configuration for a pipeline frontend app by its config ID and project ID. This endpoint returns only the client-side configuration that the frontend app needs to run in
  • Retrieve pipeline import apps activityRetrieve activity details of pipeline import apps for a given organization. Requires 'organization_id' (UUID). Returns app ID, type, name, URL, and other metadata. Supports 'local', 'custom', 'reposit
  • 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 - Configuratio
  • Retrieve Pipeline Plugin SourceRetrieve the source details of a pipeline transformation for a specific plugin by ID within an organization. Access plugin metadata, like its type, URL, and config, relevant to organizing and managing
  • 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.
  • Retrieve plugin source detailsRetrieve plugin source details by organization and plugin ID. Requires integer 'id' for the plugin and 'organization_id' as UUID. Responds with plugin attributes including type, name, and URL.
  • 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, n
  • 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.
  • 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.
  • 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
  • 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 actio
  • 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
  • Retrieve project annotation detailsCreate, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
  • 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: PersonalA
  • Retrieve project cohorts activity logRetrieve activity log for a specific project's cohorts. Requires a project_id and PersonalAPIKeyAuth with activity_log:read permission. Response includes cohort details and creator info.
  • 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` p
  • 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
  • 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.
  • Retrieve project event valuesRetrieve event values for a specific project by ID. Supports querying in CSV or JSON format. Requires a project_id and personal API key with query:read permission. Responds with event details such as
  • 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 i
  • 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
  • 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 st
  • 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.
  • 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 vi
  • 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. Respons
  • Retrieve project insights with paginationThe GET `/api/projects/{project_id}/insights/` endpoint retrieves a paginated list of insights for a specified project. Filter by creator, response format (CSV/JSON), and use limit/offset for result b
  • 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}/e
  • Retrieve project person activityThis endpoint allows reading and deleting individuals. For creating or updating, use the capture API, `$set`/`$unset` properties, or SDKs.
  • Retrieve project session valuesRetrieve session values for a specified project. Pass the project_id in the URL path to obtain the information. Only the project's ID is required as a parameter. No response body for the 200 OK status
  • 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, typ
  • Retrieve project trend insightsRetrieves saved trend insights from a PostHog project. Returns a list of all trend insights or a specific insight by short_id. Supports pagination via limit/offset and CSV/JSON output formats. Use thi
  • 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
  • Retrieve property definition detailsRetrieve details of a specific property definition by UUID within a project. Requires project_id and property definition id. Security: PersonalAPIKeyAuth with read access. No response body provided.
  • Retrieve related project groupsRetrieve related groups for a specific project and user. Requires 'project_id' (path), 'group_type_index', and user 'id' (query). Returns group details with type, key, and creation date.
  • Retrieve session property definitionsRetrieve property definitions for a specific project by providing the project's ID. Access this GET endpoint at `/api/projects/{project_id}/sessions/property_definitions/`. Project ID is mandatory. No
  • 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 us
  • Retrieve session recording error clustersRetrieve error clusters from session recordings for a specified project. This endpoint provides details on user interactions, console logs, and activity times in JSON format, requiring the project ID
  • Retrieve recordings from playlistRetrieve 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 hav
  • Retrieve session recording propertiesRetrieve properties of session recordings for a given project by ID, including activity metrics, timestamps, and participant details. Requires project_id in the path. Returns JSON data with recording
  • Retrieve session recording snapshotsSnapshots for a session can be loaded from S3 (if old) or Redis (if recent). Clients call the API without a source to get supported sources, then per source for snapshots. API v1 is deprecated; ClickH
  • 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, desti
  • 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. Sec
  • Retrieve specific historical plugin exportRetrieve historical export data for a specific plugin configuration within a project. Requires project, plugin config, and export item IDs. Auth via PersonalAPIKeyAuth. No body in 200 response.
  • 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
  • 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: PersonalAPIKeyAut
  • 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,
  • 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
  • Retrieve survey responses count by project idRetrieve the count of survey responses for a specific project by its ID. It requires the project_id parameter and returns details like the survey type, linked flags, and creator info.
  • 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
  • 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 prof
  • 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.
  • 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.
  • 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.
  • Trigger project export with format optionThe `/api/projects/{project_id}/exports/` endpoint triggers a project export, requiring `project_id` and `export_format`. It accepts JSON, form-encoded, and multipart data, responding with a 201 code
  • Validate LLM Provider API 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.

Held for approval by default (changes and sends)

Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 243 actions.

  • Bulk delete feature flagsBulk delete feature flags by filter criteria or explicit IDs. Use when you need to delete multiple feature flags at once. Accepts either 'filters' (same filter params as list endpoint: search, active,
  • Capture EventCapture (ingest) a single analytics event into PostHog using the public ingestion API and a project API key. Use when you need to send custom events like 'lesson_started', 'quiz_completed', or any use
  • 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.
  • 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: 'PersonalAPIK
  • 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.
  • 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.
  • 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 ana
  • 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
  • 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), '
  • 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 tr
  • 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.
  • 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 20
Show all 243
  • Bulk create organization invitesPOST /api/organizations/{organization_id}/invites/bulk/: Bulk-create organization invites with customizable levels, sender details, and validation checks. Supports email automation and private project
  • Create Persons Bulk DeleteTool to bulk delete persons by PostHog person IDs or distinct IDs. Use when you need to delete multiple persons at once (up to 100 per call). Only events captured before the request will be deleted. D
  • Cancel insights for a projectThe "/api/projects/{project_id}/insights/cancel/" endpoint allows users to cancel insights for a project by providing a project ID and insight details in JSON or CSV, and confirms cancellation in the
  • Create Max AI insight and queryTool 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 insig
  • Create alertTool to create a new alert configuration in PostHog. Use when you need to set up monitoring for insights with specific thresholds and notification settings. The alert will monitor the specified insigh
  • 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
  • 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
  • Create batch exports backfillsTool 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
  • Create batch exports run test stepTool 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 v
  • 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.
  • Create project insights with customizable parametersCreate custom analytics insights for a PostHog project. Supported query types (InsightVizNode.source.kind): TrendsQuery, FunnelsQuery, RetentionQuery, PathsQuery, StickinessQuery, LifecycleQuery, WebS
  • 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 cre
  • 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.
  • Create Dataset ItemsTool 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.
  • 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.
  • 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
  • Create error tracking autocapture controlsTool 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,
  • 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
  • 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 erro
  • 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 perf
  • Create evaluation runTool to create a new evaluation run and enqueue a Temporal workflow to asynchronously execute the evaluation. Use when you need to run an evaluation against a specific event in PostHog. Returns HTTP 2
  • Create event definitionsCreate 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,
  • Create experiment exposure cohortCreate a new exposure cohort for an experiment in a project by sending a POST request with experiment details and feature flag data. Requires experiment ID and project ID in the path.
  • 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.
  • 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 o
  • Create static cohort for feature flagManage feature flags for apps with create, read, update, and delete operations using PostHog's JavaScript Library or dedicated endpoint. More info in the docs.
  • Create feature flag dashboardManage feature flags by creating, reading, updating, and deleting them. Utilize JavaScript library or endpoint for user-specific flag status. Refer to documentation for details.
  • 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.
  • 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
  • Create groups types metricsTool 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 p
  • 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
  • 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 configura
  • 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 applicati
  • 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 wit
  • 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,
  • 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 metad
  • Create new organization with configurable accessCreate 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 org
  • Create organization invite with role and emailCreate 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
  • Create organization proxy record for custom domainCreate 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 cr
  • Create organization role with feature flag levelsCreate 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 l
  • 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.
  • Create person path with format optionRetrieve 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 authen
  • 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.
  • Create project action with formatThis POST endpoint creates actions for a project, accepts various data types, requires project_id and action data, optionally outputs in CSV/JSON, and needs PersonalAPIKeyAuth, returning a 201 with ac
  • Create project cohortsCreate 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. Aut
  • 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 detai
  • Create new project experimentCreate a new experiment in a specific project using JSON, form, or multipart data. Requires project_id and experiment details, secured with PersonalAPIKeyAuth. Generates a 201 response with experiment
  • 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 visual
  • Create a notebook in a projectThe API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  • 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.
  • Create Retrieve Retention Insights For ProjectCreate 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/ end
  • Create project subscription with delivery optionsCreate 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 new
  • Create project surveys with questions and targetsCreate surveys in a project by providing a project ID and details like type, questions, and targets in JSON, form-data, or urlencoded format. Use PersonalAPIKeyAuth for security. Get a survey object o
  • Create query in project by idThe `/api/projects/{project_id}/query/` POST endpoint allows users to submit queries for a specific project by providing the project ID in the URL and the query details in JSON or form data. Authentic
  • Create session recording playlistsCreate 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
  • Generate AI summary for session recordingGenerate 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
  • Create Surveys 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 sur
  • 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 o
  • 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
  • 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.
  • Delete Customer Profile ConfigTool to delete a customer profile configuration by ID in a PostHog project. Use when you need to remove a customer profile config that is no longer needed. Returns a 204 No Content status on successfu
  • 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.
  • 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.
  • Delete error tracking autocapture controlsDelete an error tracking autocapture control configuration by UUID and project ID. Use when you need to remove autocapture settings for error tracking.
  • 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.
  • Delete error tracking releaseDelete an error tracking release by its UUID and project ID. Use when you need to remove a specific release from error tracking. Requires 'error_tracking:write' scope. Returns 204 No Content on succes
  • 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.
  • 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.
  • Delete experiment saved metricTool to delete an experiment saved metric by ID from a PostHog project. Use when you need to remove a saved metric configuration from an experiment. Returns HTTP 204 No Content on success.
  • Remove feature flag role access by idDELETE /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 suc
  • 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.
  • Delete Groups Types MetricsTool 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.
  • Delete insightAttempt to delete an insight by its ID from a specific project. This action is irreversible — the insight cannot be recovered once removed. Use this action when you need to permanently remove an insig
  • Delete insight variablesDelete an insight variable by its UUID from a specified project. Requires 'insight_variable:write' permission. Returns no content with a 204 status on success.
  • 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.
  • Delete organization by uuidDelete an organization by its UUID. Requires a 'PersonalAPIKeyAuth' with 'organization:write' permission. On success, returns a 204 status code with no response body.
  • Remove organization batch export by uuidDelete 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.
  • Remove domain by uuid from organizationDelete 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).
  • Remove member from organization by uuidRemove a member from a PostHog organization by their user UUID. This action is idempotent - calling it multiple times with the same parameters will always succeed without error, even if the member has
  • Remove 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 s
  • Remove org pipeline import app by idDelete 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).
  • Remove 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
  • Remove organization plugin by idDelete 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.
  • Delete organization projectProjects for the current organization.
  • Remove 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.
  • Remove organization role by idDelete 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'.
  • 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.
  • Delete person and optionally associated eventsThis endpoint is used to read and delete user data. Use the capture API, `$set`/`$unset` commands, or SDKs for creating/updating persons.
  • 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.
  • Delete product toursDelete 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.
  • Remove specific 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).
  • Remove 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 guid
  • Remove early access feature from projectDelete 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.
  • Remove 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).
  • Remove project experiment by idSoft-delete a specific experiment by its unique integer ID within a project. Uses PATCH to set the 'deleted' field to true since PostHog experiments do not support hard DELETE. Requires a Project ID a
  • Remove explicit project member by uuidDelete 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: T
  • Remove 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
  • Remove specific project query(Experimental)
  • Remove property definition by uuidDelete 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).
  • Remove rolemembership by uuidRemove 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 t
  • Delete session recording by uuidDelete 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.
  • Remove 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
  • Delete survey by idDelete a survey by providing its UUID and the associated project ID. Requires 'survey:write' permission. Returns no content with a 204 status on success.
  • 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.
  • 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.
  • Cohort duplication 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.
  • 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 experimen
  • 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 duplicatio
  • 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.
  • 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 s
  • Flag annotation as deletedSoft delete an annotation by setting 'deleted' to true via PATCH request. Hard delete of this model is not allowed by the API.
  • Manage feature flag enrichment for usage dashboardLearn to manage feature flags (creation, access, modification, removal) using PostHog's docs, with options to use a JavaScript Library or a dedicated endpoint for user-specific flag status.
  • Crud operations for project annotationsCreate, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
  • Mark dashboard template as deletedHard delete of this model is not allowed. Use a patch API call to set "deleted" to true
  • 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
  • Create project timing insightsRecord insights as viewed by updating their last_viewed_at timestamps. This endpoint tracks when a user views insights, which is useful for: - Activity tracking and analytics - Recently viewed insight
  • Prevent hard delete notebook by flaggingHard delete of this model is not allowed. Use a patch API call to set "deleted" to true
  • Move dashboard tileEndpoint to move a tile from one dashboard to another. Requires `project_id` (in path), `id` (source dashboard ID in path), `tile` (object with `id` of the tile to move), and `toDashboard` (destinatio
  • Move file system itemMove a PostHog file-system item or folder to a new path.
  • Update alert configurationTool 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) -
  • 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 rep
  • Mark product onboarding completeTool 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
  • 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 replac
  • Patch DatasetTool to partially update a dataset in a PostHog project. Use when you need to modify dataset properties like name or description. Only the fields provided in the request will be updated; other fields
  • Patch Dataset ItemTool to partially update a dataset item by its ID in a PostHog project. Use when you need to modify specific fields of a dataset item such as input, output, metadata, or reference fields.
  • 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.
  • 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.
  • Patch EvaluationUpdate an evaluation by patching specific fields. Use when you need to modify evaluation settings like description, enabled status, or configuration.
  • Partial experiment update in projectEndpoint enables partial updates to an experiment in a project using PATCH, needing `project_id`, `experiment_id`, and various payload types. Returns updated details. Authentication is mandatory.
  • 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.
  • 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.
  • 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
  • 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.
  • Update group usage metricTool 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
  • 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 rep
  • 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 en
  • 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.
  • Update organization domain propertiesUpdates selected properties of a domain in an organization via PATCH request, supports various data formats but SAML fields are immutable. Authentication needed.
  • Update partial role details in organizationPATCH /api/organizations/{organization_id}/roles/{id}/: Update partial details of a role by ID within an organization, including name and feature flag access level. Requires UUIDs for both organizatio
  • 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.
  • Person partial update via project idThis endpoint allows reading and deleting individuals. For creation or updates, use the capture API, `$set`/`$unset` properties, or SDKs.
  • 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.
  • Update project action with partial dataUpdate an action within a project with a specified ID. Supports partial updates. Accepts JSON, form-data, and query parameters including 'project_id' and 'id'. Formats response in CSV or JSON. Require
  • Partial update project annotationCreate, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
  • Update partial project cohort detailsUpdate 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. Au
  • Partial update of a project s 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 u
  • Partial update of a project s feature flagLearn to manage feature flags (create, read, update, delete) using PostHog's docs, with options for JavaScript Library use or dedicated endpoints for user flag status.
  • Partial update of a 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.
  • Update project member role by uuidUpdate 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 endpo
  • Partial update of project notebookThe API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  • Partially update project property definitionPATCH /api/projects/{project_id}/property_definitions/{id}/: Partially update a specific property definition by UUID in a project. Requires property_definition:write auth. No response body.
  • Update partial subscription detailsPATCH /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.
  • Update partial survey detailsUpdate 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 acces
  • Update session recording playlist partiallyUpdate 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
  • Update user profileTool 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)
  • 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 upda
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
  • Rearrange pipeline transformation configsRearrange the execution order of pipeline transformation configurations for a project. This endpoint allows you to change the order in which transformation plugins are executed in the data pipeline. Y
  • 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.
  • Rearrange project pipeline destination configsRearrange the execution order of pipeline destination configurations for a project. This endpoint allows you to change the order in which destination plugins receive events in the data pipeline. You c
  • Create experiment timeseries recalculationTool 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 recal
  • Reconfigure plugin order and status in projectReconfigure the execution order and status of plugin configurations within a project. This endpoint allows you to update plugin configuration settings including: - Execution order (which plugins run f
  • 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 requir
  • 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.
  • 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 b
  • 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).
  • Run endpointTool to execute a PostHog endpoint with optional materialization and filtering. Endpoints can be HogQL queries, insights (Trends, Funnels, etc.), or other query types. Use this when you need to run a
  • Split person entities in projectThis endpoint allows reading and deleting persons; for creation or updates, use the capture API, `$set`/`$unset` properties, or SDKs.
  • Create error tracking symbol sets bulk start uploadTool to initiate bulk upload of error tracking symbol sets for a PostHog project. Use when you need to start uploading debug symbols for error tracking and source map resolution. This endpoint initial
  • Create error tracking symbol sets start uploadTool to initiate symbol set upload session for error tracking in PostHog. Use when you need to upload symbol files for stack trace symbolication. Returns a presigned S3 URL where the symbol file chunk
  • 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.
  • 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.
  • 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.
  • 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.
  • Update alert (full replacement)Tool to fully update an existing alert configuration in PostHog using PUT method. Use when you need to completely replace alert settings including name, enabled status, insight, thresholds, and subscr
  • Update annotation detailsCreate, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
  • Update batch exportTool to update an existing batch export configuration in PostHog. Use when you need to modify batch export settings like name, schedule, destination, or filtering options.
  • 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.
  • Update DatasetsTool 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.
  • 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.
  • 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.
  • 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 `
  • Update endpointTool to update an existing endpoint for a PostHog project. Use when you need to replace endpoint configuration with new values. All parameters are optional. Pass version in body or ?version=N query pa
  • Update error tracking autocapture controlsTool 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
  • 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 inst
  • Update event definition by uuidUpdate 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.
  • Update experiment detailsUpdate 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 nee
  • 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
  • Update experiment holdout (full)Tool to fully update an experiment holdout in PostHog using PUT method. Use when you need to replace all holdout configuration including name, description, and filters. All required fields must be pro
  • Update experiment saved metricsTool to update an existing experiment saved metric in PostHog. Use when you need to modify the name, description, query, or tags of a saved experiment metric. Requires the experiment saved metric ID a
  • Update external data schemaPartially update an external data schema's sync configuration.
  • Update External Data SourcesTool to update an existing external data source in PostHog (e.g., Stripe, Salesforce). Use when you need to modify the description, credentials, or configuration of an external data source. Requires b
  • Update feature flag configurationManage feature flags for your app with creation, reading, updating, and deletion options. Utilize PostHog's JS library or endpoint for flag status. More info in docs.
  • Update file systemTool to update a file system resource in PostHog by UUID and project ID. Use when you need to modify details of an existing file system resource such as path, type, depth, or metadata.
  • Update group type metricTool to update a specific group usage metric by its ID. Use when you need to modify the configuration, filters, display format, name, or calculation interval for a particular metric within a group typ
  • 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.
  • Update Insight VariableUpdate an insight variable by replacing all its properties. Use when you need to completely update all fields of an existing insight variable.
  • 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.
  • Update organization details by uuidUpdate specific details of an organization using its UUID. Allows PATCH requests with JSON, form data, or multipart. Requires `organization:write` permission. Returns updated organization info.
  • 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 org
  • Modify org info via 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 or
  • Update organization member by uuidsUpdate 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
  • Update organization member detailsUpdate member details in an organization by ID and user UUID. Requires org member write permission. Accepts JSON, form, or multipart. Responses reflect member info, including roles and security settin
  • 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
  • Update role details in organizationUpdate an organization role by submitting its UUID and organization_id in UUID format. Role details must be in JSON or form-data. Only users with 'organization:write' can do this. Returns updated role
  • Update persisted folderTool to update an existing persisted folder in PostHog. Use when you need to modify folder properties like path, protocol, or type.
  • 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.
  • Update person property endpointThis endpoint allows for reading and deleting individuals. Use the capture API, `$set` and `$unset` properties, or SDKs for creating or updating persons.
  • Update product tourUpdate an existing product tour in PostHog. Use this to modify tour name, description, targeting, content, and scheduling. Requires project_id and product tour id (UUID).
  • Update project action by idPUT 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.
  • Update project batch exportTool to update a batch export configuration within a project using PUT method. Use when you need to modify batch export settings like name, destination, interval, or pause status.
  • Update project cohort detailsUpdate 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.
  • Update project dashboard detailsEndpoint 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; respon
  • 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. Authenticatio
  • Update project event definitionUpdate an existing event definition for a specified project using its UUID. Requires a project ID and event definition write permissions. Responds without a body on success.
  • Update project group type metadataPATCH /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 charact
  • Update project insight detailsEndpoint "/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 var
  • Update project member s role by uuidUpdate 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_
  • Update project notebook detailsThe API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  • Update project property definitionUpdate a property definition in a project by its UUID. Requires a project_id and definition id, both as path parameters. Security: PersonalAPIKeyAuth with write access. No body in the response.
  • 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, descrip
  • 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.
  • Update project subscription detailsUpdate 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 `subscr
  • Update project survey detailsThe `/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
  • 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.
  • 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
  • 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

Changes wait in Needs you

Changes and sends in PostHog are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.

How approvals work

PostHog questions

Can an agent change data in PostHog on its own?

Not by default. Changes and sends in PostHog are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.

What can an agent read in PostHog?

This connector lists 263 read actions. Reads run at once, without waiting for approval.

How does PostHog connect?

It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.

Bring PostHog to your agents.

Book a discovery call