PostHog

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

Create a new analytics insight in a PostHog project. Insights are saved queries that visualize data from your analytics events. Use this to create trends, funnels, retention, or other analytics visualizations. You can define the insight using either: - Legacy 'filters' format (simpler, widely supported) - Modern 'quer…

Untrusted display-only summary

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

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

Generate an AI-powered summary for a session recording. Requires PostHog AI feature to be enabled. Provide the project_id and the session recording's UUID to get an AI-generated summary including key activities, user interactions, and insights about the session. Note: This endpoint requires PostHog AI to be enabled fo…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

Attempt 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 insight from a project. IMPORTANT: The PostHog API does not support hard deletion of insights. This endpoint returns HTTP 40…

Untrusted display-only summary