PostHog

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

Untrusted display-only summary

This endpoint is for reading and deleting person data; use the capture API, `$set`/`$unset` properties, or SDKs for creation and updates.

Untrusted display-only summary

Retrieves persons who entered or progressed through a funnel in the specified project. Note: This endpoint requires that a funnel has been previously created and analyzed in PostHog. The endpoint returns person-level data for funnel analysis. For creating or analyzing new funnels, use the insights API endpoint at /api…

Untrusted display-only summary

Retrieve pipeline frontend app details for an organization using its 'organization_id' (UUID). Response includes ID, plugin type, name, URL in JSON format, covering various plugin types.

Untrusted display-only summary

Retrieve details for repository pipeline destinations within a specific organization by its UUID. Returns objects like ID, name, and URLs with support for various plugin types (local, custom, etc.).

Untrusted display-only summary

Retrieve org pipeline transformation activity

Untrusted display-only summary

Retrieve export unsubscribe configurations for an organization's pipeline frontend apps. Returns a list of unsubscribe configurations defining how users can opt out of frontend app exports (e.g., notification bars, bug reporters). Each config includes an ID, plugin type, and settings. Required: organization_id (UUID).…

Untrusted display-only summary

Retrieve activity details for plugins in a specified organization by ID. Supports various plugin types, including local, custom, and repository. Response includes plugin's id, name, type, and relevant metrics. Requires a valid UUID for 'organization_id'.

Untrusted display-only summary

Retrieve a specific plugin's details for an organization. Requires the plugin's integer ID and the organization's UUID. Only returns plugin info if authenticated with 'plugin:read' permission. Responds with plugin data in JSON format.

Untrusted display-only summary

Retrieve plugin repository details for a specific organization by its UUID, including plugin type, name, URL, and more. Accessible via GET request to '/api/organizations/{organization_id}/plugins/repository/'.

Untrusted display-only summary

Retrieve export unsubscribe configurations for plugins in an organization. Returns a list of unsubscribe configurations for various plugin types (local, custom, repository, source, inline) that define how users can opt out of plugin-based exports. Each config includes details like plugin ID, type, name, description, U…

Untrusted display-only summary

Projects for the current organization.

Untrusted display-only summary

Retrieve the details of a specific role within an organization using its UUID. Requires the organization's UUID and role's UUID in the path and is protected by PersonalAPIKeyAuth with 'organization:read' scope. Returns role data in JSON.

Untrusted display-only summary

Retrieve unused pipeline import apps for a specified organization. Endpoint requires an organization_id (UUID) and returns details like plugin type, name, description, and more in JSON format.

Untrusted display-only summary

Retrieve a paginated list of organizations with optional 'limit' and 'offset' query parameters. The response includes organization details like ID, name, and membership level, with secure access controlled via PersonalAPIKeyAuth.

Untrusted display-only summary

Tool to retrieve a specific persisted folder by its UUID and project ID. Use when you need to get details about a persisted folder including its type, path, and timestamps.

Untrusted display-only summary

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

Untrusted display-only summary

This endpoint is used to read and delete persons. For creating or updating, use the capture API, `$set` and `$unset` properties, or SDKs.

Untrusted display-only summary

**Note**: This endpoint path appears to be incorrectly defined or deprecated in the PostHog API. The documented endpoint `/api/projects/{project_id}/persons/funnel/correlation/` returns 403 Forbidden, suggesting it either: 1. Does not exist as a standalone endpoint (correlation data may be accessed via `/api/projects/…

Untrusted display-only summary

Retrieve unique values for a specific person property across all persons in a project. Returns a list of distinct values for the specified property key, along with the count of persons who have that value. Useful for understanding the distribution of person properties like cities, countries, email domains, or any cust…

Untrusted display-only summary

Retrieve activity details for pipeline destinations within an organization. **Parameters:** - `organization_id` (required): UUID-formatted organization identifier **Returns:** JSON object with pipeline destination activity data including plugin IDs, names, versions, update information, and configuration details. **Not…

Untrusted display-only summary

Retrieve details of a specific pipeline destination config for a project by its ID. Requires project ID and destination config ID. Supports PersonalAPIKeyAuth for read access. Responds with config details including plugin info, status, and timestamps.

Untrusted display-only summary

Fetch a pipeline destination's details by ID and organization UUID, using a PersonalAPIKeyAuth with read access to plugins. Returns JSON with plugin info.

Untrusted display-only summary

Retrieve details of a specific pipeline destination plugin within an organization by its unique ID. The response includes various properties like name, description, URL, and plugin type for the given organization UUID.

Untrusted display-only summary

Retrieve activity details for pipeline front-end apps within a specified organization by organization ID. Returns JSON object with app properties such as ID, type, name, and configuration. UUID path parameter required.

Untrusted display-only summary

Retrieve detailed information about a specific pipeline frontend app within an organization. Pipeline frontend apps are site apps that inject code into websites to provide features like notification bars, bug reporters, pineapple mode, and early access features. This action returns comprehensive details including the…

Untrusted display-only summary

Retrieve details for a specific pipeline frontend app's source by its ID within an organization. Requires an integer ID of the app and UUID of the organization. Returns JSON object with app properties.

Untrusted display-only summary

Retrieve the frontend-specific configuration for a pipeline frontend app by its config ID and project ID. This endpoint returns only the client-side configuration that the frontend app needs to run in the browser, such as site app settings, UI customization options, and feature toggles. This is different from the full…

Untrusted display-only summary

Retrieve activity details of pipeline import apps for a given organization. Requires 'organization_id' (UUID). Returns app ID, type, name, URL, and other metadata. Supports 'local', 'custom', 'repository', 'source', and 'inline' plugin types.

Untrusted display-only summary

Retrieve detailed information about a specific pipeline transformation plugin by ID. Returns comprehensive plugin details including: - Plugin type (inline/custom), name, and description - Configuration schema for setting up the plugin - Capabilities (supported methods like processEvent, setupPlugin) - Version informat…

Untrusted display-only summary