PostHog

Retrieve 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.

Untrusted display-only summary

DEPRECATED: Use POSTHOG_CREATE_RETRIEVE_RETENTION_INSIGHTS_FOR_PROJECT instead. Retrieve retention insights for a specified project using PostHog's Query API. Analyzes how users return over time based on specified events or actions. Uses the /api/projects/{project_id}/query/ endpoint with a RetentionQuery. Requires a…

Untrusted display-only summary

Retrieve 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 response body is returned upon a successful call.

Untrusted display-only summary

Retrieve detailed information about a specific session recording by providing the session's UUID and associated project ID. The response includes metrics such as duration, activity, timestamps, and user data. Authentication is required.

Untrusted display-only summary

Retrieve 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 in the path.

Untrusted display-only summary

Retrieve the list of session recordings within a playlist. Returns paginated results containing recording details like duration, activity counts, and timestamps. Use this to access recordings that have been added to a specific playlist in a project.

Untrusted display-only summary

Retrieve 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 details.

Untrusted display-only summary

Snapshots 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; ClickHouse support removed.

Untrusted display-only summary

Retrieve details of a specific batch export for an organization by its UUID. Requires a PersonalAPIKeyAuth with 'batch_export:read' permission. Responses include export details like name, model, destination, interval, and more.

Untrusted display-only summary

Retrieve details for a specific batch export run within a project by ID. Requires a UUID for batch_export_id and run ID. Provides run status, record count, timestamps, latest error, and intervals. Security: PersonalAPIKeyAuth.

Untrusted display-only summary

Retrieve complete details of a specific authentication domain within an organization by its UUID. Returns domain verification status, SAML SSO configuration, JIT provisioning settings, and SSO enforcement policies. Use this to check if a domain has been verified via DNS, view SAML configuration details, or audit authe…

Untrusted display-only summary

Retrieve the content of a specific exported asset by ID within a project. Requires 'export:read' permission. Supports fetching details like creation time, format (PNG, PDF, CSV, Excel), etc.

Untrusted display-only summary

Retrieve 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.

Untrusted display-only summary

Retrieve the configuration details of a specific pipeline frontend app by providing its unique ID and the associated project ID. Pipeline frontend apps are plugins that extend PostHog's UI with custom visualizations, dashboards, and other frontend components. Returns config details including: - id: Unique identifier f…

Untrusted display-only summary

Retrieve details of a specific dashboard within a project. Requires a dashboard ID & project ID, and returns information such as dashboard properties, owner, and access levels. Auth: PersonalAPIKeyAuth[dashboard:read].

Untrusted display-only summary

Retrieve activity logs for specific survey in a project, identified by UUIDs. Requires valid API key with 'activity_log:read' permissions. Supports JSON response detailing survey's properties, types, and creator info.

Untrusted display-only summary

Retrieve survey details using survey UUID and associated project ID. Supports secure access with 'PersonalAPIKeyAuth'. Returns survey name, type, linking, targeting flags, creator info, and questions with branching logic descriptions.

Untrusted display-only summary

Retrieve 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.

Untrusted display-only summary

Retrieve export unsubscribe configurations for an organization's pipeline destinations. Returns a list of unsubscribe configurations defining how users can opt out of data exports to destinations (e.g., S3, BigQuery, Snowflake, Redshift). Each config includes an ID, plugin type, and settings. Required: organization_id…

Untrusted display-only summary

Fetch user profile info including team, organization, and notifications. Non-staff users can only retrieve their own profile using '@me' as the uuid parameter. Staff users can retrieve any user's profile using their actual UUID. Returns JSON with name, email, teams, organizations, and status.

Untrusted display-only summary

Tool to retry a failed or incomplete batch export run. Uses the same backfill mechanism as batch export backfills. Use when you need to re-execute a specific batch export run that failed or needs to be re-processed.

Untrusted display-only summary

Delete an organization invite by its UUID. Requires a valid PersonalAPIKeyAuth with organization member write permission. No response body returned on success (HTTP 204).

Untrusted display-only summary

Tool 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 predefined endpoint with custom parameters or filters.

Untrusted display-only summary

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

Untrusted display-only summary

Tool 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 initializes the bulk upload process and returns an ID mapping for tracking.

Untrusted display-only summary

Tool 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 should be uploaded. The endpoint is part of a multi-step upload process.

Untrusted display-only summary

Tool 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.

Untrusted display-only summary

Tool 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.

Untrusted display-only summary

The `/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 and export information.

Untrusted display-only summary

Tool 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.

Untrusted display-only summary