# How to integrate Posthog MCP with OpenCode

```json
{
  "title": "How to integrate Posthog MCP with OpenCode",
  "toolkit": "Posthog",
  "toolkit_slug": "posthog",
  "framework": "OpenCode",
  "framework_slug": "opencode",
  "url": "https://composio.dev/toolkits/posthog/framework/opencode",
  "markdown_url": "https://composio.dev/toolkits/posthog/framework/opencode.md",
  "updated_at": "2026-05-06T08:24:19.150Z"
}
```

## Introduction

### How to integrate Posthog MCP with OpenCode
This guide explains how to connect Posthog MCP to OpenCode using Composio Connect, which simplifies OAuth, API changes, and reliability concerns.
There are two ways to set this up:
- Via [Composio Connect MCP](https://dashboard.composio.dev/)
- Via the [Composio CLI](https://dashboard.composio.dev/)

## Also integrate Posthog with

- [ChatGPT](https://composio.dev/toolkits/posthog/framework/chatgpt)
- [OpenAI Agents SDK](https://composio.dev/toolkits/posthog/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/posthog/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/posthog/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/posthog/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/posthog/framework/codex)
- [Cursor](https://composio.dev/toolkits/posthog/framework/cursor)
- [VS Code](https://composio.dev/toolkits/posthog/framework/vscode)
- [OpenClaw](https://composio.dev/toolkits/posthog/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/posthog/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/posthog/framework/cli)
- [Google ADK](https://composio.dev/toolkits/posthog/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/posthog/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/posthog/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/posthog/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/posthog/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/posthog/framework/crew-ai)

## TL;DR

### Why use Composio?
Composio provides a single MCP server or CLI tool that exposes a set of meta-tools, allowing you to:
- Connect to 1,000+ apps with on-demand tool loading, so you do not fill your LLM context window with unnecessary tool definitions.
- Use programmatic tool calling through a remote Bash tool, letting LLMs write their own code to handle complex tool chaining. This reduces back-and-forth for frequent tool calls.
- Handle large tool responses outside the LLM context to keep conversations lean.

## Connect Posthog to OpenCode

### Connect Posthog with OpenCode
### Option 1: Using Composio CLI
### 1. Install Composio CLI
Install the Composio CLI, authenticate, and initialize your project:

```bash
# Install the Composio CLI
curl -fsSL https://composio.dev/install | bash

# Authenticate with Composio
composio login
```

## What is the Posthog MCP server, and what's possible with it?

The Posthog MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Posthog account. It provides structured and secure access to your product analytics workspace, so your agent can perform actions like managing team permissions, updating feature flag access, handling project insights, and maintaining pipeline plugins on your behalf.
- Role and team management: Seamlessly add members to organization roles, assign specific permissions, and manage dashboard collaborators for effective collaboration.
- Feature flag access control: Let your agent assign role-based access to feature flags, ensuring precise rollout and permission management for new features.
- Project insight handling: Cancel ongoing insights for a project or bookmark key activity notifications, helping your team stay focused on actionable analytics.
- Pipeline plugin and app updates: Automate the process of checking for updates and statuses of pipeline destinations, import apps, and transformation plugins to keep your analytics infrastructure healthy.
- Bulk organization invites: Efficiently send out and manage organization invitations in bulk, streamlining onboarding for new team members and stakeholders.

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `POSTHOG_ADD_DASHBOARD_COLLABORATORS_WITH_ACCESS_LEVEL` | Add dashboard collaborators with access level | Add collaborators to a specific project dashboard. requires 'project id' and 'dashboard id'. supports json, form-urlencoded, and multipart data. returns added collaborator details. auth: 'personalapikeyauth'. |
| `POSTHOG_ADD_MEMBER_TO_ORGANIZATION_ROLE` | Add member to organization role | Add 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. |
| `POSTHOG_ADD_PROJECT_SPECIFIC_MEMBER_ROLES` | Add project specific member roles | Add members with specific roles to a project by providing their user uuid and level (member or admin). requires project id in the url. supports json, form-data, and form-urlencoded input. returns the newly created membership data upon success. |
| `POSTHOG_ASSIGN_FEATURE_FLAG_ROLE_BASED_ACCESS` | Assign feature flag role based access | Set up role-based access for a feature flag using `project id` and `feature flag id`. submit access info in json or form format, with `feature flag:write` rights. success returns new details with a 201 code. |
| `POSTHOG_BOOKMARK_PROJECT_ACTIVITY_NOTIFICATION` | Bookmark project activity notification | Create a bookmark for an activity notification in a project's activity log. requires a `project id` and json payload with activity details. supports verification status, impersonation flags, and system activity distinction. |
| `POSTHOG_BULK_CREATE_ORGANIZATION_INVITES` | Bulk create organization invites | Post /api/organizations/{organization id}/invites/bulk/: bulk-create organization invites with customizable levels, sender details, and validation checks. supports email automation and private project access settings. |
| `POSTHOG_CANCEL_INSIGHTS_FOR_A_PROJECT` | Cancel insights for a project | The "/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 response. |
| `POSTHOG_CHECK_PIPELINE_DESTINATION_UPDATES` | Check pipeline destination updates | Get the newest updates and plugin info for a pipeline destination by organization and destination id via get request to /api/.../{id}/check for updates. |
| `POSTHOG_CHECK_PIPELINE_IMPORT_APP_UPDATES` | Check pipeline import app updates | Retrieve the latest update information for a specific pipeline import app by its id within an organization. this endpoint returns details such as plugin type, name, description, and version data. requires 'id' and 'organization id' as path parameters. |
| `POSTHOG_CHECK_PIPELINE_PLUGIN_UPDATE_STATUS` | Check pipeline plugin update status | Get update status for a specific pipeline transformation plugin by its unique id within an organization. this endpoint requires the 'organization id' and 'plugin' ids and returns details like plugin type, name, and update information. |
| `POSTHOG_CHECK_PROJECT_S_DEMO_DATA_GENERATION_STATUS` | Check project s demo data generation status | Projects for the current organization. |
| `POSTHOG_COHORT_DUPLICATION_TO_STATIC` | Cohort duplication to static | This 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. |
| `POSTHOG_CREATE_A_NOTEBOOK_IN_A_PROJECT` | Create a notebook in a project | The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement. |
| `POSTHOG_CREATE_CUSTOM_PROJECT_INSIGHTS` | Create project insights with customizable parameters | The post endpoint enables creating insights for projects using a project id and supports json/csv. it offers detailed parameters for customizing insights and returns structured data with personalapikeyauth for security. |
| `POSTHOG_CREATE_DASHBOARD_FROM_TEMPLATE_IN_PROJECT` | Create dashboard from template in project | Create a new dashboard for a specified project from a template. accepts project id in the path and a json payload with various dashboard object parameters. returns a dashboard instance on success. |
| `POSTHOG_CREATE_DOMAIN_WITH_SAML_FOR_ORGANIZATION` | Create domain with saml for organization | Create a domain for a specific organization by post to `/api/organizations/{id}/domains` with json/form data. requires domain, saml setup, and write permissions. returns new domain data with status 201. |
| `POSTHOG_CREATE_EXPERIMENT_EXPOSURE_COHORT` | Create experiment exposure cohort | Create 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. |
| `POSTHOG_CREATE_FEATURE_FLAG_DASHBOARD` | Create feature flag dashboard | Manage feature flags by creating, reading, updating, and deleting them. utilize javascript library or endpoint for user-specific flag status. refer to documentation for details. |
| `POSTHOG_CREATE_FEATURE_FLAGS_FOR_PROJECT` | Create feature flags for project | Manage feature flags by creating, reading, updating, and deleting them using posthog's javascript library or api endpoint. details in the provided documentation. |
| `POSTHOG_CREATE_FRONTEND_APP_PIPELINE_CONFIG` | Create frontend app pipeline config | Create a config for pipeline frontend apps within a specified project. requires project id and payload with object properties such as plugin, enabled status, order, etc. returns newly created config details. |
| `POSTHOG_CREATE_FUNNEL_ANALYSIS_FOR_PROJECT_PERSONS` | Create funnel analysis for project persons | This endpoint handles reading and deleting persons. for creation or updates, use the capture api, `$set` or `$unset` properties, or sdks. |
| `POSTHOG_CREATE_NEW_ORGANIZATION_WITH_CONFIGURABLE_ACCESS` | Create new organization with configurable access | Post /api/organizations/ - create a new organization with details like name, membership level, and features access. requires organization:write permission. returns organization info on success. |
| `POSTHOG_CREATE_NEW_PROJECT_EXPERIMENT` | Create new project experiment | 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. |
| `POSTHOG_CREATE_ORGANIZATION_INVITE_WITH_ROLE_AND_EMAIL` | Create organization invite with role and email | Send invites with roles (member, admin, owner) via email to join an organization by id. use json, form data, or multipart with a personal api key for security. successful invites return a 201 status. |
| `POSTHOG_CREATE_ORGANIZATION_ROLE_WITH_FEATURE_FLAG_LEVELS` | Create organization role with feature flag levels | Create a new role for the specified organization by supplying role details. requires organization id (uuid) and role data in json. returns the created role on success with a 201 status code. security: personalapikeyauth. |
| `POSTHOG_CREATE_ORG_PROXY_RECORD_WITH_DOMAIN_AND_STATUS` | Create org proxy record with domain and status | Create a proxy record for an org by sending org id in url and json/form/multipart data with domain, target cname, and status. requires personalapikeyauth and org write access; returns record details. |
| `POSTHOG_CREATE_PERSON_FUNNEL_CORRELATION` | Create person funnel correlation | This endpoint is for reading and deleting persons. use the capture api, `$set`/`$unset` properties, or sdks to create or update them. |
| `POSTHOG_CREATE_PERSON_PATH_WITH_FORMAT_OPTION` | Create person path with format option | This api endpoint is for reading and deleting users. use the capture api, `$set`/`$unset` properties, or sdks for creating/updating users. |
| `POSTHOG_CREATE_PIPELINE_DESTINATION_CONFIG` | Create pipeline destination config | Create pipeline destination configurations for a specific project by submitting plugin and order details, among other configuration info, with required project id. authentication needed. responds with 201 on success. |
| `POSTHOG_CREATE_PIPELINE_DESTINATION_CONFIG_JOB` | Create pipeline destination config job | Create a job for a pipeline destination config with a specific id within the specified project. requires project id & config id in the path, and a json payload with plugin and order info. |
| `POSTHOG_CREATE_PIPELINE_IMPORT_APPS_CONFIG_JOB` | Create pipeline import apps config job | A job imports app settings into a project pipeline using project id and plugin config id, accepting json/form/multipart, and specifies plugin details, enabling status, and order for pipeline import apps configs. |
| `POSTHOG_CREATE_PLUGIN_JOB_CONFIGURATION` | Create plugin job configuration | Create a job-related configuration for a specific plugin by providing plugin and project ids. accepts json, form data, and returns config details on success. use carefully; requires mandatory fields. |
| `POSTHOG_CREATE_PROJECT_ACTION_WITH_FORMAT` | Create project action with format | 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. |
| `POSTHOG_CREATE_PROJECT_COHORTS` | Create project cohorts | 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. |
| `POSTHOG_CREATE_PROJECT_DASHBOARD` | Create project dashboard | 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. |
| `POSTHOG_CREATE_PROJECT_INSIGHTS_WITH_FORMAT_OPTION` | Create project insights with format option | Create project insights with optional csv/json format parameter. requires `project id` in the path and a json body with project insight details. supports personal api key authentication. successful requests return a 201 status code with insight data. |
| `POSTHOG_CREATE_PROJECT_PIPELINE_APP_CONFIGS` | Create project pipeline app configs | Create pipeline app configurations for a specified project via post, requiring a project id and json, form, or multipart payload. supports configs, plugins, and app details. returns 201 on success. auth required. |
| `POSTHOG_CREATE_PROJECT_PIPELINE_FRONTEND_APP_JOB` | Create project pipeline frontend app job | 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. |
| `POSTHOG_CREATE_PROJECT_PIPELINE_TRANSFORMATION_CONFIG` | Create project pipeline transformation config | Create a pipeline transformation config within a specific project by posting json, form, or multipart data. include plugin id, order, and enabled status. ensure project id is in the path. authentication required. |
| `POSTHOG_CREATE_PROJECT_PLUGIN_CONFIGURATION` | Create project plugin configuration | Create a new plugin configuration for a specified project by post to /api/projects/{project id}/plugin configs/. requires project id and json payload with plugin details; must authenticate with personalapikeyauth. |
| `POSTHOG_CREATE_PROJECT_SUBSCRIPTION_WITH_DELIVERY_OPTIONS` | Create project subscription with delivery options | 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. |
| `POSTHOG_CREATE_PROJECT_SURVEYS_WITH_QUESTIONS_AND_TARGETS` | Create project surveys with questions and targets | 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. |
| `POSTHOG_CREATE_PROJECT_TIMING_INSIGHTS` | Create project timing insights | Create timing insights for a project by post to /api/projects/{project id}/insights/timing, supporting csv or json. it returns a 200 status with content in the chosen format. |
| `POSTHOG_CREATE_QUERY_IN_PROJECT_BY_ID` | Create query in project by id | 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. |
| `POSTHOG_CREATE_RETRIEVE_RETENTION_INSIGHTS_FOR_PROJECT` | Create retrieve retention insights for project | Create and retrieve retention insights for a project using its id, allowing csv/json outputs. requires an api key with `insight:read` permissions and supports query node json strings and old dashboard ids. |
| `POSTHOG_CREATE_SESSION_RECORDING_IN_PLAYLIST` | Create session recording in playlist | The post endpoint generates a project's session recording, needing 'project id', 'short id', and 'session recording id' in the url, and accepts various content formats for recording details. |
| `POSTHOG_CREATE_SESSION_RECORDING_PLAYLISTS` | Create session recording playlists | 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. |
| `POSTHOG_CREATE_SESSION_RECORDING_SUMMARY` | Create session recording summary | Summarize a session recording by providing the project id and the recording's uuid. get details like duration, activities, and user info. |
| `POSTHOG_CREATE_STATIC_COHORT_FOR_FEATURE_FLAG` | Create static cohort for feature flag | Manage feature flags for apps with create, read, update, and delete operations using posthog's javascript library or dedicated endpoint. more info in the docs. |
| `POSTHOG_CRUD_OPERATIONS_FOR_PROJECT_ANNOTATIONS` | Crud operations for project annotations | Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations. |
| `POSTHOG_CUSTOM_PROJECT_FUNNEL_ANALYTICS_WITH_ADVANCED_OPTIONS` | Project Funnel Advanced Analytics | The `/api/projects/{project id}/insights/funnel/` endpoint generates customizable funnel insights for a project in either csv or json, offering filtering, exclusion, and ordering features with cachable results. specify output with the `format` query. |
| `POSTHOG_DELETE_ORGANIZATION_BY_UUID` | Delete organization by uuid | Delete an organization by its uuid. requires a 'personalapikeyauth' with 'organization:write' permission. on success, returns a 204 status code with no response body. |
| `POSTHOG_DELETE_ORGANIZATION_PROJECT` | Delete organization project | Projects for the current organization. |
| `POSTHOG_DELETE_PERSON_AND_OPTIONALLY_ASSOCIATED_EVENTS` | Delete person and optionally associated events | This endpoint is used to read and delete user data. use the capture api, `$set`/`$unset` commands, or sdks for creating/updating persons. |
| `POSTHOG_DELETE_SESSION_RECORDING_BY_UUID` | Delete session recording by uuid | Delete 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. |
| `POSTHOG_DELETE_SURVEY_BY_ID` | Delete survey by id | Delete a survey by providing its uuid and the associated project id. requires 'survey:write' permission. returns no content with a 204 status on success. |
| `POSTHOG_ENABLE_PROJECT_EARLY_ACCESS_FEATURE` | Enable project early access feature | Enables a new early access feature for a project using project id, payload with details, and personalapikeyauth. returns a 201 status on success. |
| `POSTHOG_FETCH_BATCH_EXPORT_DETAILS_VIA_UUID` | Fetch batch export details via uuid | Retrieve logs for a specific batch export within a project by its uuid. endpoint requires project id and export id (uuid). supports json responses detailing export properties, run statuses, and error info. |
| `POSTHOG_FETCH_EXPORT_UNSUBSCRIBE_SETTINGS` | Fetch export unsubscribe settings | Retrieve pipeline transformation export unsubscribe configurations for a specified organization by its uuid. returns details including id, plugin type, and configuration schema in json format. |
| `POSTHOG_FETCH_FRONTEND_APP_CONFIG_STATUS` | Fetch frontend app config status | Retrieve activity details for a specific pipeline frontend app config by id within a project. requires both `project id` and config `id` in the path. returns json with app config details like plugin info, enablement, order, and error status. |
| `POSTHOG_FETCH_ORGANIZATION_DETAILS_BY_UUID` | Fetch organization details by uuid | Retrieve organization details by uuid. endpoint requires 'organization:read' access. response includes name, slug, timestamps, membership, plugins access level, and team structure. |
| `POSTHOG_FETCH_ORGANIZATION_PIPELINE_APP_REPOSITORIES` | Fetch organization pipeline app repositories | Retrieve details of pipeline import app repositories for a specific organization by its uuid. returns json with properties like plugin type, name, and url. supports 'local', 'custom', 'repository', 'source', 'inline' types. |
| `POSTHOG_FETCH_PIPELINE_DESTINATION_DETAILS` | Fetchpipelinedestinationdetails | Use a get request to '/api/projects/{project id}/pipeline destination configs/{id}/activity/' to get details, status, config, and metrics for a pipeline destination by id, returning json. |
| `POSTHOG_FETCH_PIPELINE_TRANSFORMATION_DETAILS` | Fetch pipeline transformation details | Retrieve details of pipeline transformations from a specified organization's repository. requires `organization id` (uuid). returns json with properties like id, plugin type, and name. supports filtering by types like local, custom, repository, etc. |
| `POSTHOG_FETCH_PROJECT_EXPERIMENT_SECONDARY_DATA` | Fetch project experiment secondary data | Fetch secondary experiment data in a project by its unique id, using project and experiment ids as path parameters. authenticated by personalapikeyauth, it returns a json with experiment info, features, and metrics. |
| `POSTHOG_FETCH_PROJECT_SURVEY_ACTIVITY_LOG` | Fetch project survey activity log | Retrieve 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 including types, flags, questions, and metadata. |
| `POSTHOG_FETCH_SESSION_RECORDING_PLAYLIST_DETAILS` | Fetch session recording playlist details | Retrieve session recording playlist details for a specific project by project id and playlist short id. requires personalapikeyauth with read access. returns playlist metadata including creation and modification info. |
| `POSTHOG_FLAG_ANNOTATION_AS_DELETED` | Flag annotation as deleted | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_GENERATE_PROJECT_FUNNEL_CORRELATION_INSIGHT` | Generate project funnel correlation insight | The /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. |
| `POSTHOG_GET_UNUSED_ORG_PIPELINE_FRONTEND_APPS` | Retrieve unused organization pipeline frontend apps | Retrieve unused pipeline frontend apps for a specific organization by its uuid. returns details like app ids, types, names, descriptions, and other metadata in json format. requires organization id in path. |
| `POSTHOG_INITIATE_DOMAIN_VERIFICATION_WITH_SAML_CONFIG` | Initiate domain verification with saml config | Post /api/organizations/{organization id}/domains/{id}/verify/: initiates verification for a domain within an organization using its uuid, updating its verification status and related saml configuration attributes. supports json and form data formats. |
| `POSTHOG_INITIATE_PIPELINE_TRANSFORMATION_JOB` | Initiate pipeline transformation job | Create a pipeline transformation job for a specified plugin config in a project by posting to `/api/projects/{project id}/pipeline transformation configs/{id}/job/`. requires project id and plugin config id. |
| `POSTHOG_LIST_AND_FILTER_PROJECT_EVENTS` | List and filter project events | This endpoint for listing/filtering events is deprecated and maintained only for compatibility. users are discouraged from using it and should use the query endpoint for ad-hoc lists/aggregations or cdp/batch exports for bulk exports. |
| `POSTHOG_LIST_AND_MANAGE_PROJECT_ANNOTATIONS` | List and manage project annotations | Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations. |
| `POSTHOG_LIST_AND_MANAGE_PROJECT_FEATURE_FLAGS` | List and manage project feature flags | Manage feature flags with creation, reading, updating, and deletion capabilities. utilize javascript library or an endpoint for application integration. more details in the docs. |
| `POSTHOG_LIST_BATCH_EXPORT_RUNS_WITH_PAGINATION_AND_ORDERING` | List Batch Export Runs | List runs for a batch export by `batch export id` within a project. supports pagination & ordering of the results. requires `batch export:read` permission. returns status, errors, counts, and timestamps for each run. |
| `POSTHOG_LIST_DASHBOARD_SHARING_CONFIGS` | List dashboard sharing configs | Retrieve 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 sharing settings. |
| `POSTHOG_LIST_FEATURE_FLAG_ROLE_ACCESS_DETAILS` | List feature flag role access details | This 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. |
| `POSTHOG_LIST_NOTEBOOKS_WITH_FILTERS_AND_PAGINATION` | List notebooks with filters and pagination | The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement. |
| `POSTHOG_LIST_OF_PROJECT_S_SESSION_RECORDING_PLAYLISTS` | List of project s session recording playlists | Retrieve a list of session recording playlists for a specific project. filter by creator, paginate with limit and offset, and identify playlists with project id and optional short id. requires 'session recording playlist:read' permission. |
| `POSTHOG_LIST_OR_DELETE_PERSONS_WITH_OPTIONAL_FILTERS` | List or delete persons with optional filters | This endpoint is for reading/deleting persons. for creating/updating, use the capture api, set/unset properties, or sdks. |
| `POSTHOG_LIST_ORGANIZATION_DOMAINS_WITH_PAGINATION` | List organization domains with pagination | Fetch a list of an organization's domains with pagination using `limit` and `offset`. access requires `organization id` and a personalapikeyauth. optional parameters available. provides domain info, verification, and saml setup. |
| `POSTHOG_LIST_ORGANIZATION_INVITES_WITH_PAGINATION` | List organization invites with pagination | Retrieve a paginated list of invites for a specific organization, identified by `organization id`, with optional `limit` and `offset` query params for result customization. requires `organization member:read` permission. |
| `POSTHOG_LIST_ORGANIZATION_MEMBERS_WITH_PAGINATION` | List organization members with pagination | Retrieve members list from an organization with 'limit' and 'offset' options using personalapikeyauth and organization id. access requires organization member:read permission. returns members' details and statuses. |
| `POSTHOG_LIST_ORGANIZATION_PLUGINS_WITH_PAGINATION` | Listorganizationpluginswithpagination | Retrieve the list of plugins for a specified organization. supports pagination through 'limit' and 'offset' query parameters. requires a valid organization uuid and personalapikeyauth for access. returns plugin details including types and status. |
| `POSTHOG_LIST_ORGANIZATION_ROLES_WITH_PAGINATION` | List organization roles with pagination | Fetch a paginated list of roles in an organization using its uuid. supports query parameters for limits and offsets. access needs personalapikeyauth. returns details like id, name, and creator info. |
| `POSTHOG_LIST_ORGANIZATION_S_BATCH_EXPORTS_WITH_PAGINATION` | List organization s batch exports with pagination | Retrieve 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. |
| `POSTHOG_LIST_ORGANIZATION_S_PAGINATED_PROXY_RECORDS` | List organization s paginated proxy records | Retrieve a paginated list of an organization's proxy records by id, with 'limit' and 'offset' options. 'organization id' and 'personalapikeyauth' are necessary. includes status, domain, and counts. |
| `POSTHOG_LIST_ORGANIZATION_S_PIPELINE_DESTINATIONS` | List organization s pipeline destinations | Retrieve 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 organization info. |
| `POSTHOG_LIST_ORGANIZATION_S_PIPELINE_FRONTEND_APPS` | List organization s pipeline frontend apps | Retrieve a paginated list of pipeline apps for an organization using 'plugin:read' personalapikeyauth. requires organization id (uuid) and supports limit and offset parameters. includes app types and statuses. |
| `POSTHOG_LIST_ORGANIZATION_S_PIPELINE_IMPORT_APPS` | List organization s pipeline import apps | Retrieve a paginated list of pipeline import applications for a specified organization by id. supports optional 'limit' and 'offset' query parameters for result pagination. requires an organization uuid and a personal api key for authentication. |
| `POSTHOG_LIST_ORGANIZATION_S_PIPELINE_TRANSFORMATIONS` | List organization s pipeline transformations | Retrieve paginated pipeline transformation lists for an organization using `limit` and `offset`, requiring a uuid and personalapikeyauth. supports filtering and detailed views. |
| `POSTHOG_LIST_PAGINATED_SURVEYS_FOR_A_PROJECT` | List paginated surveys for a project | Get paginated surveys for a project with its id, using 'limit' and 'offset'. needs personalapikeyauth ('survey:read'). json output includes survey info, links, and metadata. |
| `POSTHOG_LIST_PIPELINE_DESTINATION_CONFIGS_WITH_PAGINATION` | List pipeline destination configs with pagination | List pipeline destination configurations for a given project by id, with optional pagination through 'limit' and 'offset' query parameters. returns details such as plugin info and delivery rates. authentication required. |
| `POSTHOG_LIST_PIPELINE_FRONTEND_APP_CONFIGS` | List pipeline frontend app configs | Retrieve paginated configurations for pipeline frontend apps associated with a specified project. query parameters 'limit' and 'offset' control pagination. requires a project id and personalapikeyauth for access. supports json responses. |
| `POSTHOG_LIST_PROJECT_ACTIONS_WITH_PAGINATION_AND_FILTERS` | List project actions with pagination and filters | Get paginated project actions with filters by format. query params: limit, offset. needs personalapikeyauth for read. includes id, name, description, metadata. |
| `POSTHOG_LIST_PROJECT_BATCH_EXPORTS_WITH_PAGINATION` | List project batch exports with pagination | Retrieve 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. |
| `POSTHOG_LIST_PROJECT_CONFIGURATION_PLUGIN_LOGS` | List project configuration plugin logs | Retrieve logs for a specific plugin configuration within a project. supports pagination with limit and offset query parameters. requires project and plugin configuration ids. auth: personalapikeyauth with plugin:read scope. |
| `POSTHOG_LIST_PROJECT_DASHBOARD_COLLABORATORS` | List project dashboard collaborators | Get dashboard collaborators list in a project using project string id and dashboard integer id. requires personalapikeyauth and `dashboard:read` permission. returns details like access level and timestamps. |
| `POSTHOG_LIST_PROJECT_DASHBOARDS_WITH_PAGINATION` | List project dashboards with pagination | Get paginated dashboards for a project by id, using 'limit' and 'offset'. must authenticate with personalapikeyauth. includes count, pagination, and dashboard details. |
| `POSTHOG_LIST_PROJECT_DASHBOARD_TEMPLATES` | List project dashboard templates | "retrieve a paginated list of dashboard templates for a specified project. use 'limit' and 'offset' query parameters to control result pagination. requires project's id in the path and supports personalapikeyauth for security." |
| `POSTHOG_LIST_PROJECT_EARLY_ACCESS_FEATURES` | List project early access features | Retrieve 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. |
| `POSTHOG_LIST_PROJECT_EXPERIMENTS_WITH_PAGINATION` | List project experiments with pagination | Get 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. |
| `POSTHOG_LIST_PROJECT_EXPORT_ITEMS_WITH_PAGINATION` | List project export items with pagination | Retrieve a paginated list of export items for a specific project by id with optional 'limit' and 'offset' query parameters. requires personalapikeyauth for export:read permission. supports multiple export formats. |
| `POSTHOG_LIST_PROJECT_GROUP_TYPES_BY_ID` | List project group types by id | Retrieve a list of group types within a specific project by providing the project id. this endpoint requires authentication with a personalapikey and grants read access to group data. |
| `POSTHOG_LIST_PROJECT_MEMBERSHIP_DETAILS` | List project membership details | Retrieve 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. |
| `POSTHOG_LIST_PROJECT_PIPELINE_CONFIGURATIONS` | List project pipeline configurations | Fetch paginated pipeline configuration list for a project by its id, utilizing optional `limit` and `offset`. endpoint returns json data. |
| `POSTHOG_LIST_PROJECT_PIPELINE_IMPORT_CONFIGS` | Listprojectpipelineimportconfigs | List pipeline import app configurations for a specified project, with pagination options 'limit' and 'offset'. requires a project id and supports personalapikeyauth for security. responds with json objects including configuration details. |
| `POSTHOG_LIST_PROJECT_PLUGIN_CONFIGURATIONS` | List project plugin configurations | Retrieve a paginated list of plugin configurations for a specific project by project id. supports optional 'limit' & 'offset' query params for result batching. requires 'personalapikeyauth' for 'plugin:read' access. |
| `POSTHOG_LIST_PROJECT_SESSION_RECORDINGS` | List project session recordings | Retrieve a paginated list of session recordings for a specific project, including viewing times and user interactions. specify `project id`, and use optional `limit` and `offset` query parameters to control result set size and starting point. |
| `POSTHOG_LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATION` | List projects in organization with pagination | Projects for the current organization. |
| `POSTHOG_LIST_PROJECT_SUBSCRIPTIONS_WITH_PAGINATION` | List project subscriptions with pagination | Retrieve a paginated list of subscriptions for a given project by its id. optional query params include 'limit' for results per page and 'offset' for results starting index. authentication is required. returns subscription details and navigation links. |
| `POSTHOG_LIST_ROLE_MEMBERSHIPS_PAGINATED` | Listrolemembershipspaginated | Retrieve a paginated list of role memberships for a specific role within an organization, including membership details. optional query parameters ‘limit’ and ‘offset’ control pagination; ‘organization id’ and ‘role id’ are path parameters. |
| `POSTHOG_LIST_SESSION_RECORDING_SHARING_CONFIGS` | List session recording sharing configs | Retrieve a list of sharing configurations for a specific session recording in a project, including creation timestamps and access tokens. requires project and recording ids. |
| `POSTHOG_LIST_SPECIFIC_TYPE_GROUPS_WITH_PAGINATION` | List specific type groups with pagination | List 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/ |
| `POSTHOG_LIST_UNUSED_ORGANIZATION_PIPELINE_TRANSFORMATIONS` | List unused organization pipeline transformations | Retrieve 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. |
| `POSTHOG_LIST_USERS_WITH_STAFF_FILTER_AND_PAGINATION` | List users with staff filter and pagination | Api endpoint fetches a user list with staff filter, pagination (limit, offset), and requires a personal api key. data includes uuids, emails, and organizational details. |
| `POSTHOG_MANAGE_FEATURE_FLAG_ENRICHMENT_FOR_USAGE_DASHBOARD` | Manage feature flag enrichment for usage dashboard | Learn 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. |
| `POSTHOG_MANAGE_PROJECT_FEATURE_FLAGS` | Manage project feature flags | Learn to manage feature flags: create, read, update, delete, and check their status using the javascript library or an endpoint. consult the linked docs for details. |
| `POSTHOG_MANAGE_PROJECT_FEATURE_FLAGS_FOR_LOCAL_EVALUATION` | Manage project feature flags for local evaluation | Utilize feature flags to manage application features with creation, reading, updating, and deletion. consult posthog's docs or use their js library or endpoint for user-specific flag checks. |
| `POSTHOG_MANAGE_USER_FEATURE_FLAGS` | Manage user feature flags | Manage feature flags in your app with create, read, update, and delete options. use posthog's javascript library or endpoint to verify user access. see documentation for details. |
| `POSTHOG_MARK_DASHBOARD_TEMPLATE_AS_DELETED` | Mark dashboard template as deleted | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_MARK_INSIGHT_AS_VIEWED_WITH_CONFIGURABLE_FORMAT` | Mark insight as viewed with configurable format | The post endpoint marks an insight as viewed for a specified project, requires `project id` and `id`, supports `csv` or `json` formats, and returns fast-loading serialized data. |
| `POSTHOG_MARK_PROJECT_ACTION_AS_DELETED` | Mark project action as deleted | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_MARK_SESSION_RECORDING_PLAYLIST_DELETED` | Mark session recording playlist deleted | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_MARK_SUBSCRIPTION_AS_DELETED_BY_ID` | Mark subscription as deleted by id | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_MODIFY_ORG_INFO_VIA_UUID` | Modify org info via uuid | Put /api/organizations/{id}/: update organization details by providing a uuid as 'id'. supports json, form-urlencoded, multipart/form-data. requires 'organization:write' permission. returns updated organization data. |
| `POSTHOG_MOVE_DASHBOARD_TILE` | Move dashboard tile | Endpoint to move a tile within a dashboard by `id`. requires `project id`, accepts json/form-data (e.g., `name`, `pinned`), and returns updated dashboard info. |
| `POSTHOG_PARTIAL_EXPERIMENT_UPDATE_IN_PROJECT` | Partial experiment update in project | Endpoint 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. |
| `POSTHOG_PARTIALLY_UPDATE_PROJECT_PLUGIN_CONFIG` | Partially update project plugin config | Update plugin configuration partially for a specified project using patch on '/api/projects/{project id}/plugin configs/{id}'. requires plugin write authority. accepts json, form data, and multipart. returns updated plugin config details. |
| `POSTHOG_PARTIALLY_UPDATE_PROJECT_PROPERTY_DEFINITION` | Partially update project property definition | Patch /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. |
| `POSTHOG_PARTIAL_PIPELINE_FRONTEND_APP_CONFIG_UPDATE` | Partial pipeline frontend app config update | Patch method to partially update config of a pipeline frontend app for a project by id. requires write permission on plugin. accepts json, form-data; returns updated config details. |
| `POSTHOG_PARTIAL_UPDATE_OF_A_PROJECT_INSIGHT` | Partial update of a project insight | The patch endpoint supports partial insight updates in a project, allows format specification (csv/json), and requires `personalapikeyauth` and `insight:write` scope for access. |
| `POSTHOG_PARTIAL_UPDATE_OF_A_PROJECT_S_DASHBOARD` | Partial update of a project s dashboard | Endpoint patch /api/projects/{project id}/dashboards/{id}: allows partial update of a project's dashboard with specified id. accepts json, form data, and provides a detailed response schema based on user license. requires dashboard write access. |
| `POSTHOG_PARTIAL_UPDATE_OF_A_PROJECT_S_FEATURE_FLAG` | Partial update of a project s feature flag | Learn 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. |
| `POSTHOG_PARTIAL_UPDATE_OF_PROJECT_NOTEBOOK` | Partial update of project notebook | The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement. |
| `POSTHOG_PARTIAL_UPDATE_PROJECT_ANNOTATION` | Partial update project annotation | Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations. |
| `POSTHOG_PERSIST_SESSION_RECORDING_DATA_BY_UUID` | Persist session recording data by uuid | Post `/api/projects/{project id}/session recordings/{id}/persist`: endpoint for persisting session recording data identified by uuid. requires `project id` and accepts json containing various read-only session metrics. responds with session data. |
| `POSTHOG_PERSON_PARTIAL_UPDATE_VIA_PROJECT_ID` | Person partial update via project id | This endpoint allows reading and deleting individuals. for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks. |
| `POSTHOG_PERSON_PROPERTY_DELETION_ENDPOINT` | Person property deletion endpoint | This endpoint is for reading and deleting user data. use the capture api, `$set`/`$unset`, or sdks for creating/updating users. |
| `POSTHOG_PREVENT_HARD_DELETE_NOTEBOOK_BY_FLAGGING` | Prevent hard delete notebook by flagging | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_PROJECT_TREND_ANALYTICS` | Post Project Trends With Filters | The `/api/projects/{project id}/insights/trend/` endpoint provides project trends in csv/json, requires `project id` and optional parameters, and needs 'personalapikeyauth'. it outputs event data and cache status. |
| `POSTHOG_REARRANGE_FRONTEND_APP_PIPELINE_CONFIGS` | Rearrange frontend app pipeline configs | Patch /api/projects/{project id}/pipeline frontend apps configs/rearrange/: rearrange the config of frontend apps in a project's pipeline. requires project id in the path and a json object in the request body. responds with updated config details. |
| `POSTHOG_REARRANGE_PIPELINE_TRANSFORMATION_CONFIGS` | Rearrange pipeline transformation configs | Endpoint `/api/projects/{project id}/pipeline transformation configs/rearrange/` allows for partial updates to the arrangement of pipeline configurations for a given project. accepts patch requests with necessary parameters and the project id in the path. |
| `POSTHOG_REARRANGE_PROJECT_IMPORT_APP_CONFIGURATIONS` | Rearrange project import app configurations | Rearrange 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. |
| `POSTHOG_REARRANGE_PROJECT_PIPELINE_DESTINATION_CONFIGS` | Rearrange project pipeline destination configs | "patch /api/projects/{project id}/pipeline destination configs/rearrange/": adjust order and settings of pipeline destinations for a project by project id. requires json body with plugin, enabled state, etc. returns updated configuration. |
| `POSTHOG_RECONFIGURE_PLUGIN_ORDER_AND_STATUS_IN_PROJECT` | Reconfigure plugin order and status in project | Patch endpoint to reconfigure the order of plugins within a project by project id. supports json, form, and multipart bodies to update plugin order and status. |
| `POSTHOG_REMOVE_DOMAIN_BY_UUID_FROM_ORGANIZATION` | Remove domain by uuid from organization | Delete 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). |
| `POSTHOG_REMOVE_EARLY_ACCESS_FEATURE_FROM_PROJECT` | Remove early access feature from project | Delete 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. |
| `POSTHOG_REMOVE_EXPLICIT_PROJECT_MEMBER_BY_UUID` | Remove explicit project member by uuid | Delete 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. |
| `POSTHOG_REMOVE_FEATURE_FLAG_ROLE_ACCESS_BY_ID` | Remove feature flag role access by id | 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). |
| `POSTHOG_REMOVE_MEMBER_FROM_ORGANIZATION_BY_UUID` | Remove member from organization by uuid | Delete /api/organizations/{org id}/members/{user uuid}: removes a specific member from an organization using uuids for both entities. requires 'organization member:write' permission; returns 204 with no content on success. |
| `POSTHOG_REMOVE_ORGANIZATION_BATCH_EXPORT_BY_UUID` | Remove organization batch export by uuid | Delete 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. |
| `POSTHOG_REMOVE_ORGANIZATION_PIPELINE_DESTINATION` | Remove organization pipeline destination | Delete a specific pipeline destination in an organization by id. requires an integer 'id' of the destination, and the organization's 'uuid'. auth: personalapikey with plugin:write. no return body on success (204). |
| `POSTHOG_REMOVE_ORGANIZATION_PIPELINE_TRANSFORMATION` | Remove organization pipeline transformation | Delete a specific pipeline transformation plugin for an organization by id. requires a uuid for the organization and an integer for the plugin. auth: personalapikey with write access. no response body on success (204). |
| `POSTHOG_REMOVE_ORGANIZATION_PLUGIN_BY_ID` | Remove organization plugin by id | Delete 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. |
| `POSTHOG_REMOVE_ORGANIZATION_PROXY_RECORD` | Remove organization proxy record | Delete 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. |
| `POSTHOG_REMOVE_ORGANIZATION_ROLE_BY_ID` | Remove organization role by id | Delete 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'. |
| `POSTHOG_REMOVE_ORG_PIPELINE_IMPORT_APP_BY_ID` | Remove org pipeline import app by id | Delete 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). |
| `POSTHOG_REMOVE_PIPELINE_DESTINATION_CONFIG` | Remove pipeline destination config | Delete a pipeline destination configuration by specifying a unique integer id within a project. requires 'plugin:write' permission via personalapikeyauth. no response body on success (204). project id is mandatory. |
| `POSTHOG_REMOVE_PIPELINE_FRONTEND_APP_BY_ID` | Remove pipeline frontend app by id | Delete a specific pipeline frontend app by its id within an organization. requires the organization id (uuid) and the app's integer id. auth: personalapikeyauth with plugin:write scope. no response body on success (204). |
| `POSTHOG_REMOVE_PIPELINE_FRONTEND_APP_CONFIG` | Remove pipeline frontend app config | Delete a pipeline frontend app configuration for a specific project. requires 'project id' and config 'id' in the path and 'plugin:write' permissions. responds with 204 on success without a body. |
| `POSTHOG_REMOVE_PIPELINE_IMPORT_APP_CONFIG` | Remove pipeline import app config | Delete a specific pipeline import app configuration using its id within a project. requires project id and config id, and auth via personalapikeyauth with plugin write access. no response body on success (204). |
| `POSTHOG_REMOVE_PIPELINE_TRANSFORMATION_CONFIG_BY_ID` | Remove pipeline transformation config by id | Delete a specific pipeline transformation configuration by id within a project. requires the project id and configuration id. secured by personalapikeyauth with plugin:write access. no response body upon success (204). |
| `POSTHOG_REMOVE_PROJECT_DASHBOARD_COLLABORATOR` | Remove project dashboard collaborator | Remove a collaborator from a project dashboard. provide the project id, dashboard id, and user's uuid. requires 'dashboard:write' permissions. expect no response body on success (204). project id guidance at '/api/projects/'. |
| `POSTHOG_REMOVE_PROJECT_EVENT_DEFINITION` | Remove project event definition | Delete an event definition by providing its uuid and the associated project id. requires `event definition:write` permission. successful deletion returns no content (204 status). |
| `POSTHOG_REMOVE_PROJECT_EXPERIMENT_BY_ID` | Remove project experiment by id | Delete a specific experiment by its unique integer id within a project. requires a project id and personal api key with experiment write permission. no response body upon success. |
| `POSTHOG_REMOVE_PROJECT_PLUGIN_CONFIGURATION` | Remove project plugin configuration | Delete /api/projects/{project id}/plugin configs/{id}/: removes a specific plugin configuration by id from a given project. requires 'plugin:write' permissions and project id. returns 204 with no body on success. |
| `POSTHOG_REMOVE_PROPERTY_DEFINITION_BY_UUID` | Remove property definition by uuid | Delete 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). |
| `POSTHOG_REMOVE_ROLE_MEMBERSHIP_BY_UUID` | Remove rolemembership by uuid | Delete /api/organizations/{org id}/roles/{role id}/role memberships/{id}: removes a role membership from an organization using a specific uuid. requires write access. returns 204 on success. |
| `POSTHOG_REMOVE_SESSION_RECORDING_FROM_PLAYLIST` | Remove session recording from playlist | Delete a session recording from a playlist using its id within a specified project. requires project id, short id, and session recording id in the path. returns no content on success (204). |
| `POSTHOG_REMOVE_SPECIFIC_PROJECT_BATCH_EXPORT` | Remove specific project batch export | Delete 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). |
| `POSTHOG_REMOVE_SPECIFIC_PROJECT_QUERY` | Remove specific project query | (experimental) |
| `POSTHOG_RETRIEVE_AND_DELETE_PROJECT_PERSON_TRENDS` | Retrieve and delete project person trends | This endpoint is for reading and deleting persons. use the capture api, `$set`/`$unset` properties, or sdks for creating/updating persons. |
| `POSTHOG_RETRIEVE_APP_METRICS_BY_IDS` | Retrieve app metrics by ids | Retrieve app-specific metrics for a given project by providing the project id and app metric id. requires a personal api key with plugin:read access. no response body provided upon success (200). |
| `POSTHOG_RETRIEVE_APP_METRICS_ERROR_DETAILS` | Retrieve app metrics error details | Retrieves detailed error information for a specific app metric by id within a project. requires project id and metric's integer id as path parameters. no response body for a successful query. |
| `POSTHOG_RETRIEVE_ASYNC_QUERY_STATUS_BY_ID` | Retrieve async query status by id | (experimental) |
| `POSTHOG_RETRIEVE_BATCH_EXPORT_DETAILS` | Retrieve batch export details | Retrieve details of a specific batch export by its uuid in a project. requires project id and batch export id. supports personalapikeyauth and responds with export details including destination, interval, and status. |
| `POSTHOG_RETRIEVE_BATCH_EXPORT_LOGS_BY_UUID` | Retrieve batch export logs by uuid | Retrieve logs for a specific batch export given by uuid within an organization. essential for tracking export status, errors, and configurations. supports json responses detailing export properties and history. |
| `POSTHOG_RETRIEVE_BATCH_EXPORT_RUN_LOGS` | Retrieve batch export run logs | Retrieve logs for a specific batch export run within a project. requires `project id`, `batch export id`, and `id` (all uuids). the endpoint returns run status, error info, record count, and timestamps. |
| `POSTHOG_RETRIEVE_COHORT_ACTIVITY_DETAILS` | Retrieve cohort activity details | Retrieve 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:read' scope. |
| `POSTHOG_RETRIEVE_COHORT_PERSON_DETAILS` | Retrieve cohort person details | Retrieve 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. |
| `POSTHOG_RETRIEVE_DASHBOARD_TEMPLATE_DETAILS_BY_UUID` | Retrieve dashboard template details by uuid | Fetch specific dashboard template details by uuid in a project with 'dashboard template:read' rights using a personalapikeyauth. returns name, description, filters, and creation info. |
| `POSTHOG_RETRIEVE_DASHBOARD_TEMPLATE_SCHEMA` | Retrieve dashboard template schema | Retrieve 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. |
| `POSTHOG_RETRIEVE_EVENT_DEFINITION_BY_UUID` | Retrieve event definition by uuid | Retrieve an event definition by its uuid within a specified project. requires a project id and an event definition id, with access secured by personalapikeyauth. (get /api/projects/{project id}/event definitions/{id}) |
| `POSTHOG_RETRIEVE_EVENT_DEFINITIONS_BY_PROJECT_ID` | Retrieve event definitions by project id | Retrieve 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 successful call. |
| `POSTHOG_RETRIEVE_EXPERIMENT_DETAILS_BY_IDS` | Retrieve experiment details by ids | Access 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. |
| `POSTHOG_RETRIEVE_EXPERIMENTS_REQUIRING_FLAG_IMPLEMENTATION` | Retrieve experiments requiring flag implementation | Retrieve details for experiments that require feature flag implementation in a specific project. requires a valid 'project id' and user must have 'experiment:read' permission. returns information like experiment names, dates, flags, and creation data. |
| `POSTHOG_RETRIEVE_EXPORT_UNSUBSCRIBE_CONFIGS` | Retrieve export unsubscribe configs | Retrieve the configuration for unsubscribing from exports in the pipeline import apps for a specific organization. requires an organization uuid in the path. returns various properties including ids, plugin types, and metadata as a json object. |
| `POSTHOG_RETRIEVE_FEATURE_FLAG_ACTIVITY_DETAILS` | Retrieve feature flag activity details | Manage 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/feature-flags) |
| `POSTHOG_RETRIEVE_FEATURE_FLAG_DETAILS` | Retrieve feature flag details | This guide details how to manage (create, read, update, delete) feature flags in applications using posthog's javascript library or endpoint. for more info, visit the provided documentation. |
| `POSTHOG_RETRIEVE_FEATURE_FLAG_ROLE_ACCESS_DETAILS` | Retrieve feature flag role access details | Retrieve 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. |
| `POSTHOG_RETRIEVE_FEATURE_FLAGS_ACTIVITY_LOG` | Retrieve feature flags activity log | Learn 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/docs/user-guides/feature-flags). |
| `POSTHOG_RETRIEVE_FEATURE_FLAGS_EVALUATION_REASONS` | Retrieve feature flags evaluation reasons | Manage feature flags—create, read, update, delete—using the posthog javascript library or endpoint for user-specific flag status. (more in docs). |
| `POSTHOG_RETRIEVE_FILTERED_PROJECT_PROPERTY_DEFINITIONS` | Retrieve filtered project property definitions | Get 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. |
| `POSTHOG_RETRIEVE_FUNNEL_INSIGHTS_IN_PROJECT` | Retrieve funnel insights in project | Gain insights from funnel analysis of a specific project by providing its id and having 'insight:read' permission. supports json/csv formats and offers detailed info like creation, modification, and dashboards quickly. |
| `POSTHOG_RETRIEVE_GROUP_PROPERTY_DEFINITIONS_BY_PROJECT_ID` | Retrieve group property definitions by project id | Retrieve 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. |
| `POSTHOG_RETRIEVE_GROUP_PROPERTY_VALUES_BY_INDEX_AND_KEY` | Retrieve group property values by index and key | Retrieve 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. |
| `POSTHOG_RETRIEVE_HEDGEHOG_CONFIGURATION_BY_UUID` | Retrieve hedgehog configuration by uuid | Retrieve user's hedgehog configuration details by their uuid. this endpoint requires the user's uuid as a path parameter and returns various user-related settings such as email, team info, timezone, and more in json format. supports get requests. |
| `POSTHOG_RETRIEVE_HISTORICAL_APP_METRICS_EXPORT` | Retrieve historical app metrics export | Retrieve 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. |
| `POSTHOG_RETRIEVE_IMPORTANT_PROJECT_ACTIVITY_LOG` | Retrieve important project activity log | Retrieve a log of important changes for a specified project. requires a `project id` and returns details about the change, including user info, read status, and timestamps. use `/api/projects/{project id}` to obtain project ids. |
| `POSTHOG_RETRIEVE_INSIGHT_SHARING_CONFIGURATIONS` | Retrieve insight sharing configurations | Retrieve sharing configurations for a specific insight within a project, requiring project and insight ids. validates access via personalapikeyauth. returns data such as creation time and access tokens. |
| `POSTHOG_RETRIEVE_LAST_VIEWED_INSIGHTS_FOR_USER` | Retrieve last viewed insights for user | Returns basic details about the last 5 insights viewed by this user. most recently viewed first. |
| `POSTHOG_RETRIEVE_MATCHING_EVENTS_FOR_SESSION_RECORDING` | Retrieve matching events for session recording | Retrieves 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. |
| `POSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_FOR_PROJECT` | Retrieve notebook activity for project | The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement. |
| `POSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_LOG` | Retrieve notebook activity log | The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement. |
| `POSTHOG_RETRIEVE_NOTEBOOK_DETAILS` | Retrieve notebook details | The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement. |
| `POSTHOG_RETRIEVE_OR_DELETE_PERSON_RETENTION_DATA` | Retrieve or delete person retention data | This endpoint is for reading and deleting person data; use the capture api, `$set`/`$unset` properties, or sdks for creation and updates. |
| `POSTHOG_RETRIEVE_OR_DELETE_PROJECT_PERSONS_FUNNEL_DATA` | Retrieve or delete project persons funnel data | This api endpoint is for reading and deleting user data. use the capture api, `$set` and `$unset` properties, or sdks for creating/updating users. |
| `POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_FRONTEND_APP` | Retrieve organization pipeline frontend app details | 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. |
| `POSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_UNSUBSCRIBE_CONFIGS` | Retrieve organization pipeline unsubscribe configs | Retrieve unsubscribe config details for an organization's pipeline frontend apps. requires an organization id (uuid). returns json with config data including plugin types and more. |
| `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_ACTIVITY` | Retrieve organization plugin activity | 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'. |
| `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_DETAILS` | Retrieve organization plugin details | 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. |
| `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_REPOSITORY_DETAILS` | Retrieve organization plugin repository details | 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/'. |
| `POSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_UNSUBSCRIBE_CONFIGS` | Retrieve organization plugin unsubscribe configs | Retrieve plugin export unsubscribe configurations for a specified organization by organization id. supports local, custom, repository, source, and inline plugin types, providing details like name, description, url, and icon. |
| `POSTHOG_RETRIEVE_ORGANIZATION_PROJECT_DETAILS` | Retrieve organization project details | Projects for the current organization. |
| `POSTHOG_RETRIEVE_ORGANIZATION_ROLE_DETAILS` | Retrieve organization role details | 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. |
| `POSTHOG_RETRIEVE_ORGANIZATION_S_PIPELINE_REPOSITORY_DETAILS` | Retrieve Org Pipeline Repo Details | 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.). |
| `POSTHOG_RETRIEVE_ORGANIZATION_S_UNUSED_PIPELINE_APPS` | Retrieve organization s unused pipeline apps | 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. |
| `POSTHOG_RETRIEVE_ORG_PIPELINE_TRANSFORMATION_ACTIVITY` | Retrieve org pipeline transformation activity | Retrieve pipeline transformation activity details for a specific organization using its uuid. returns data such as plugin type, name, description, and related metrics. requires 'organization id' in url path. |
| `POSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LIST` | Retrieve paginated organization list | 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. |
| `POSTHOG_RETRIEVE_PERSON_DETAILS_BY_ID` | Retrieve person details by id | This endpoint is used to read and delete persons. for creating or updating, use the capture api, `$set` and `$unset` properties, or sdks. |
| `POSTHOG_RETRIEVE_PERSON_DETAILS_BY_PROJECT` | Retrieve person details by project | This endpoint allows reading and deleting persons; for creation or updates, use the capture api, the `$set` and `$unset` properties, or sdks. |
| `POSTHOG_RETRIEVE_PERSON_LIFECYCLE_DETAILS` | Retrieve person lifecycle details | This endpoint is for reading and deleting persons. use the capture api, property methods, or sdks for creating or updating persons. |
| `POSTHOG_RETRIEVE_PERSON_PROPERTIES_TIMELINE` | Retrieve person properties timeline | This endpoint allows reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons. |
| `POSTHOG_RETRIEVE_PERSON_S_ACTIVITY_AND_DELETE_OPTIONS` | Retrieve person s activity and delete options | This endpoint is for reading and deleting persons; for creating/updating, use the capture api, `$set`/`$unset` properties, or sdks. |
| `POSTHOG_RETRIEVE_PERSONS_FUNNEL_CORRELATION_DATA` | Retrieve persons funnel correlation data | This endpoint is for reading and deleting persons. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons. |
| `POSTHOG_RETRIEVE_PERSON_VALUES_BY_PROJECT` | Retrieve person values by project | This endpoint is for reading and deleting persons. for creation or updates, use the [capture api](https://posthog.com/docs/api/capture), `$set`/`$unset`, or sdks. |
| `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_ACTIVITY` | Retrieve pipeline destination activity | Retrieve activity details for pipeline destinations within an organization. required: uuid-formatted `organization id`. outputs application/json with attributes: id, latest tag, etc. supports `get` requests. |
| `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_CONFIG_DETAILS` | Retrieve pipeline destination config details | 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. |
| `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_DETAILS` | Retrieve pipeline destination details | Fetch a pipeline destination's details by id and organization uuid, using a personalapikeyauth with read access to plugins. returns json with plugin info. |
| `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_FRONTEND_CONFIG` | Retrieve pipeline destination frontend config | Retrieve configuration details for a specific pipeline destination in a project by getting the frontend data of the config with a given id. this endpoint requires the 'project id' and 'id' of the config. |
| `POSTHOG_RETRIEVE_PIPELINE_DESTINATION_PLUGIN_DETAILS` | Retrieve pipeline destination plugin details | 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. |
| `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_ACTIVITY` | Retrieve pipeline frontend app activity | 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. |
| `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_DETAILS` | Retrieve pipeline frontend app details | Retrieves details of a specified pipeline frontend app within an organization. requires plugin read access and organization id (uuid), and app id (integer) as path parameters. returns json with app information. |
| `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_SOURCE_DETAILS` | Retrieve pipeline frontend app source details | 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. |
| `POSTHOG_RETRIEVE_PIPELINE_FRONTEND_PLUGIN_CONFIG` | Retrieve pipeline frontend plugin config | Retrieve the frontend configuration for a specific plugin in a project's pipeline. requires project and config ids and returns details like plugin info, status, and creation timestamps. |
| `POSTHOG_RETRIEVE_PIPELINE_IMPORT_APP_DETAILS` | Retrieve pipeline import app details | Access specific pipeline import app details in an organization using its id and a valid organization uuid. requires 'personalapikeyauth' with 'plugin:read' access. outputs app properties in json format. |
| `POSTHOG_RETRIEVE_PIPELINE_IMPORT_APPS_ACTIVITY` | Retrieve pipeline import apps activity | 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. |
| `POSTHOG_RETRIEVE_PIPELINE_IMPORT_APP_SOURCE_DETAILS` | Retrieve pipeline import app source details | Retrieves source details of a pipeline import app by its id within a specified organization. expects `organization id` (uuid) and `id` (integer) as path parameters. returns app properties including type, name, and related info. |
| `POSTHOG_RETRIEVE_PIPELINE_PLUGIN_DETAILS_BY_ID` | Retrieve pipeline plugin details by id | Retrieve pipeline transformation plugin details by id for a specified organization. requires authentication and provides information like plugin type, name, and configuration for authorized users. supports json response. |
| `POSTHOG_RETRIEVE_PIPELINE_PLUGIN_SOURCE` | Retrieve Pipeline Plugin Source | Retrieve 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 pipeline operations. |
| `POSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_ACTIVITY` | Retrieve pipeline transformation activity | Retrieve the activity details of a specific pipeline transformation configuration in a project using its unique integer id. requires project id. returns json including config, plugin info, and activity data. |
| `POSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_CONFIG` | Retrieve pipeline transformation config | Retrieve the configuration for a specific pipeline transformation plugin in a project by its id using a get request. requires project id and plugin config id in the path and 'plugin:read' permission. |
| `POSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_FRONTEND_CONFIG` | Retrieve pipeline transformation frontend config | Retrieve 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. |
| `POSTHOG_RETRIEVE_PLUGIN_CONFIG_ACTIVITY` | Retrieve plugin config activity | Retrieve activity details for a specific plugin config within a project's pipeline import apps. requires 'project id' and plugin config 'id' within the api path. |
| `POSTHOG_RETRIEVE_PLUGIN_CONFIG_ACTIVITY_DETAILS` | Retrieve plugin config activity details | Retrieve activity details for a specific plugin configuration within a project. requires `project id` and unique `id` of the plugin config. responds with plugin info, status, and activity metrics. |
| `POSTHOG_RETRIEVE_PLUGIN_CONFIG_DETAILS` | Retrieve plugin config details | Retrieve the configuration details of a specific plugin by its id for a given project. this endpoint requires a project id and plugin config id, with read permission, and returns an object containing config settings and status. |
| `POSTHOG_RETRIEVE_PLUGIN_CONFIG_FRONTEND` | Retrieve plugin config frontend | Retrieve the frontend configuration of an app's pipeline import by id within a specified project. requires `project id` and `id` of the plugin config. returns json object with config details. |
| `POSTHOG_RETRIEVE_PLUGIN_FRONTEND_CONFIG` | Retrieve plugin frontend config | Retrieve the frontend configuration of a specific plugin for a given project. requires the project id and plugin config id. provides details including plugin state, order, and related info. |
| `POSTHOG_RETRIEVE_PLUGIN_SOURCE_DETAILS` | Retrieve plugin source details | Retrieve 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. |
| `POSTHOG_RETRIEVE_PLUGIN_UPDATE_INFO` | Retrieve plugin update info | This endpoint retrieves update information for a specific plugin within an organization's pipeline frontend app by its integer id and the organization's uuid. it returns details such as plugin type, name, and latest version. |
| `POSTHOG_RETRIEVE_PLUGIN_UPDATE_STATUS` | Retrieve plugin update status | Retrieve the latest update status for a specific plugin, identified by its integer id, within an organization specified by uuid. check compatibility and change logs. |
| `POSTHOG_RETRIEVE_PROJECT_ACTION_DETAILS_BY_ID` | Retrieve project action details by id | Get details on a project action by id. supports json/csv format via query. needs 'project id' and 'id' path parameters. secured by personalapikeyauth. |
| `POSTHOG_RETRIEVE_PROJECT_ACTIVITY_DETAILS` | Retrieve project activity details | Projects for the current organization. |
| `POSTHOG_RETRIEVE_PROJECT_ACTIVITY_INSIGHTS` | Retrieve project activity insights | Retrieve activity insights for a specific project by project id, supporting csv or json formats. requires an api key with activity log:read permission. limited to essential data to enhance response time for large datasets. |
| `POSTHOG_RETRIEVE_PROJECT_ACTIVITY_LOG_WITH_PAGINATION` | Retrieve project activity log with pagination | Access a project's activity log using pagination and cursor-based navigation. requires project id and personalapikeyauth. outputs activity list with user data and timestamps. |
| `POSTHOG_RETRIEVE_PROJECT_ANNOTATION_DETAILS` | Retrieve project annotation details | Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations. |
| `POSTHOG_RETRIEVE_PROJECT_COHORT_DETAILS` | Retrieve project cohort details | Retrieve detailed information about a specific cohort within a project using its id. requires project id and cohort id; returns cohort details including name, creator info, and status. auth: personalapikeyauth with cohort:read permission. |
| `POSTHOG_RETRIEVE_PROJECT_COHORTS_ACTIVITY_LOG` | Retrieve project cohorts activity log | Retrieve 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. |
| `POSTHOG_RETRIEVE_PROJECT_COHORTS_WITH_PAGINATION` | Retrieve project cohorts with pagination | Retrieve a paginated list of cohorts for a specific project using `project id`. supports `limit` and `offset` query params to customize the response. requires `personalapikeyauth` with `cohort:read` permissions. |
| `POSTHOG_RETRIEVE_PROJECT_DRAFT_SQL_QUERY` | Retrieve project draft sql query | Retrieve the draft sql query for a specific project using its project id. ensure to obtain the project id by calling /api/projects/. note: this endpoint does not return a response body. |
| `POSTHOG_RETRIEVE_PROJECT_EARLY_ACCESS_FEATURE_DETAILS` | Retrieve project early access feature details | Retrieve details of a specific early access feature in a project by id. requires project id and feature uuid. must have 'early access feature:read' permission. returns feature details including status, flag info, and timestamps. |
| `POSTHOG_RETRIEVE_PROJECT_EVENT_DETAILS_BY_ID` | Retrieve project event details by id | Retrieve 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. |
| `POSTHOG_RETRIEVE_PROJECT_EVENT_VALUES` | Retrieve project event values | Retrieve 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 id, distinct id, properties, etc. |
| `POSTHOG_RETRIEVE_PROJECT_EXPERIMENT_RESULTS` | Retrieve project experiment results | Retrieve experiment results within a project by project and experiment id. requires project id and experiment id in the path. returns experiment details in json, with authentication via personalapikeyauth. |
| `POSTHOG_RETRIEVE_PROJECT_EXPORT_DETAILS` | Retrieve project export details | Retrieve detailed info on a specific export of a project using its unique id. requires project id and supports various export formats like png, pdf, csv, and xlsx. auth: personalapikeyauth with export:read scope. |
| `POSTHOG_RETRIEVE_PROJECT_FUNNEL_CORRELATION_INSIGHTS` | Retrieve project funnel correlation insights | Retrieve insights about funnel correlations for a specific project by id, offering results in json or csv. supports querying and output formatting, with a focus on fast loading of large datasets. |
| `POSTHOG_RETRIEVE_PROJECT_GROUP_DETAILS_BY_KEY_AND_TYPE` | Retrieve project group details by key and type | Retrieves 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. |
| `POSTHOG_RETRIEVE_PROJECT_INSIGHT_ACTIVITY_DATA` | Retrieve project insight activity data | Retrieve insights activity for a specific project and insight id, offering data in json or csv format. requires project id and insight id in the path, with optional data format query. secure access via personalapikeyauth. |
| `POSTHOG_RETRIEVE_PROJECT_INSIGHT_DETAILS` | Retrieve project insight details | Retrieve details for a specific project insight by id, with options to format as json/csv, request refresh, and specify dashboard context. supports personalapikeyauth with insight read access. responses include metadata, results, and caching info. |
| `POSTHOG_RETRIEVE_PROJECT_INSIGHTS_DETAILS` | Retrieve project insights details | Retrieve detailed insights for a specific project using its id. queries can be made in csv or json format. requires 'insight:read' permission. results include various metadata like creation, last refresh, and associated dashboard info. |
| `POSTHOG_RETRIEVE_PROJECT_INSIGHTS_WITH_PAGINATION` | Retrieve project insights with pagination | The 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 batching. requires `insight:read` permission. |
| `POSTHOG_RETRIEVE_PROJECT_MEMBER_DETAILS_BY_UUID` | Retrieve project member details by uuid | Retrieve detailed information about a specific user's membership level and status within a project by their uuid. access project members' data, roles, and timestamps. (get /api/projects/{project id}/explicit members/{uuid}) |
| `POSTHOG_RETRIEVE_PROJECT_PERSON_ACTIVITY` | Retrieve project person activity | This endpoint allows reading and deleting individuals. for creating or updating, use the capture api, `$set`/`$unset` properties, or sdks. |
| `POSTHOG_RETRIEVE_PROJECT_PERSON_COHORTS` | Retrieve project person cohorts | This endpoint allows reading and deletion of persons; for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks. |
| `POSTHOG_RETRIEVE_PROJECT_PERSON_STICKINESS` | Retrieve project person stickiness | This endpoint allows for reading and deleting persons. for creations or updates, use the capture api, set/unset properties, or sdks. |
| `POSTHOG_RETRIEVE_PROJECT_PIPELINE_PLUGIN_CONFIG` | Retrieve project pipeline plugin config | Retrieve configuration details of a specific plugin for a given project pipeline by id. requires a valid project id and plugin config id. supports personalapikeyauth for 'plugin:read' access. responds with json containing configuration data. |
| `POSTHOG_RETRIEVE_PROJECT_SESSION_VALUES` | Retrieve project session values | Retrieve 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 code. |
| `POSTHOG_RETRIEVE_PROJECT_SUBSCRIPTION_DETAILS` | Retrieve project subscription details | Retrieve a specific subscription for a project, identified by 'project id' and 'id'. requires valid api key with read access. supports get method, returns subscription details including frequency, type, and creator info. |
| `POSTHOG_RETRIEVE_PROJECT_TREND_INSIGHTS` | Retrieve project trend insights | Retrieve trend insights for a specific project, supporting csv or json formats. mandatory project id required. provides details on insight cache status, creator, and associated dashboards. auth: personalapikeyauth. |
| `POSTHOG_RETRIEVE_PROPERTIES_AND_EVENTS_ASSOCIATION` | Retrieve properties and events association | Allows 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 |
| `POSTHOG_RETRIEVE_PROPERTY_DEFINITION_DETAILS` | Retrieve property definition details | Retrieve 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. |
| `POSTHOG_RETRIEVE_PROXY_RECORD_DETAILS` | Retrieve proxy record details | Retrieve a specific proxy record's details by id within an organization. requires path parameters 'organization id' and 'id'. returns json data including domain, status, and timestamps. auth: personalapikeyauth with 'organization:read'. |
| `POSTHOG_RETRIEVE_RELATED_PROJECT_GROUPS` | Retrieve related project groups | 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. |
| `POSTHOG_RETRIEVE_RETENTION_INSIGHTS` | Retrieveretentioninsights | Retrieve retention insights for a specified project. options to output in csv or json format. requires a project id and supports query customization. authenticated access with 'insight:read' permission necessary. |
| `POSTHOG_RETRIEVE_SESSION_PROPERTY_DEFINITIONS` | Retrieve session property definitions | 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. |
| `POSTHOG_RETRIEVE_SESSION_RECORDING_DETAILS` | Retrieve session recording details | 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. |
| `POSTHOG_RETRIEVE_SESSION_RECORDING_ERROR_CLUSTERS` | Retrieve session recording error clusters | 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. |
| `POSTHOG_RETRIEVE_SESSION_RECORDING_PLAYLIST_DETAILS` | Retrieve session recording playlist details | Retrieve session recording playlists for a specified project and playlist short id. returns details like name, creator info, and recordings. access by making a get request to `/api/projects/{project id}/session recording playlists/{short id}/recordings/`. |
| `POSTHOG_RETRIEVE_SESSION_RECORDING_PROPERTIES_BY_PROJECT_ID` | Retrieve session recording properties | 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. |
| `POSTHOG_RETRIEVE_SESSION_RECORDING_SNAPSHOTS` | Retrieve session recording snapshots | 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. |
| `POSTHOG_RETRIEVE_SIMILAR_SESSION_RECORDINGS` | Retrieve similar session recordings | Retrieve similar session recordings for a given session by uuid within a project. details include session activity data, user info, and timestamps. requires `project id` and session `id`. |
| `POSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_DETAILS` | Retrieve specific batch export details | 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. |
| `POSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_RUN_DETAILS` | Retrieve specific batch export run details | 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. |
| `POSTHOG_RETRIEVE_SPECIFIC_DOMAIN_DETAILS` | Retrieve specific domain details | Retrieve details of a specific domain within an organization using its uuid. authorized users can check domain verification status and saml configuration. requires the `personalapikeyauth` with `organization:read` scope. |
| `POSTHOG_RETRIEVE_SPECIFIC_EXPORTED_ASSET_CONTENT` | Retrieve specific exported asset content | 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. |
| `POSTHOG_RETRIEVE_SPECIFIC_HISTORICAL_PLUGIN_EXPORT` | Retrieve specific historical plugin export | 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. |
| `POSTHOG_RETRIEVE_SPECIFIC_PIPELINE_FRONTEND_APP_CONFIG` | Retrievespecificpipelinefrontendappconfig | Retrieve the configuration details of a specific pipeline frontend app by providing its unique id and the associated project id. permissions: 'plugin:read'. response includes plugin config info like enabled state and creation timestamp. |
| `POSTHOG_RETRIEVE_SPECIFIC_PROJECT_DASHBOARD_DETAILS` | Retrieve specific project dashboard details | 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]. |
| `POSTHOG_RETRIEVE_SURVEY_ACTIVITY_LOGS` | Retrieve survey activity logs | 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. |
| `POSTHOG_RETRIEVE_SURVEY_DETAILS_WITH_UUID_AND_PROJECT_ID` | Retrieve survey details with uuid and project id | 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. |
| `POSTHOG_RETRIEVE_SURVEY_RESPONSES_COUNT_BY_PROJECT_ID` | Retrieve survey responses count by project id | 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. |
| `POSTHOG_RETRIEVE_UNSUBSCRIBED_PIPELINE_CONFIGS` | Retrieve unsubscribed pipeline configs | Retrieve config details for unsubscribed pipeline destinations in an organization. requires 'organization id' (uuid). returns plugin info, name, description, and more in json format. |
| `POSTHOG_RETRIEVE_UNUSED_ORGANIZATION_PLUGINS` | Retrieve unused organization plugins | Retrieve a list of unused plugins for a specified organization by its uuid. the response includes plugin details such as type, name, and configuration. access restricted to the specified organization's context. |
| `POSTHOG_RETRIEVE_UNUSED_PIPELINE_DESTINATIONS` | Retrieveunusedpipelinedestinations | Retrieve unused pipeline destinations for a specified organization by id. this get endpoint returns a json object with details like destination id, plugin type, and url, among other attributes. (uuid for organization id is required.) |
| `POSTHOG_RETRIEVE_USER_DETAILS_FOR_INITIATING2_FA_SETUP` | Retrieve user details for initiating 2fa setup | The endpoint `get /api/users/{uuid}/start 2fa setup/` fetches details for initiating 2fa setup for a user, providing information like email status, password presence, and more. fields are mostly read-only. |
| `POSTHOG_RETRIEVE_USER_PROFILE_AND_TEAM_DETAILS` | Retrieve user profile and team details | Fetch user info like profile, team, org, and notifications via uuid using personalapikeyauth ('user:read'). returns json with name, email, teams, and status. |
| `POSTHOG_REVOKE_ORGANIZATION_INVITE` | Revoke organization invite | Delete an organization invite by its uuid. requires a valid personalapikeyauth with organization member write permission. no response body returned on success (http 204). |
| `POSTHOG_SET_INSIGHT_DELETION_FLAG` | Set insight deletion flag | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_SOFT_DELETE_A_SPECIFIC_COHORT_BY_ID` | Soft delete a specific cohort by id | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_SOFT_DELETE_FEATURE_FLAG_BY_SETTING_STATUS` | Soft delete feature flag by setting status | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_SOFT_DELETE_PROJECT_DASHBOARD` | Soft delete project dashboard | Hard delete of this model is not allowed. use a patch api call to set "deleted" to true |
| `POSTHOG_SPLIT_PERSON_ENTITIES_IN_PROJECT` | Split person entities in project | This endpoint allows reading and deleting persons; for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks. |
| `POSTHOG_TRIGGER_PROJECT_EXPORT_WITH_FORMAT_OPTION` | Trigger project export with format option | 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. |
| `POSTHOG_UPDATE_ANNOTATION_DETAILS` | Update annotation details | Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations. |
| `POSTHOG_UPDATE_EARLY_ACCESS_PROJECT_FEATURE` | Update early access project feature | This patch endpoint updates a specific early access project feature. it requires `project id` and `id` (uuid) as path parameters. the body can include feature details like `name`, `description`, and `stage`. security: `personalapikeyauth`. |
| `POSTHOG_UPDATE_EVENT_DEFINITION_BY_UUID` | Update event definition by uuid | Update 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. |
| `POSTHOG_UPDATE_EXPERIMENT_DETAILS` | Update experiment details | Update an experiment by sending a put request with `project id` and `id`, including new details as json/form data. changes to name, description, dates, etc., allowed. `experiment:write` permission needed. |
| `POSTHOG_UPDATE_FEATURE_FLAG_CONFIGURATION` | Update feature flag configuration | Manage 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. |
| `POSTHOG_UPDATE_ORGANIZATION_DETAILS_BY_UUID` | Update organization details by uuid | Update 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. |
| `POSTHOG_UPDATE_ORGANIZATION_DOMAIN_INFO_AND_SAML_CONFIG` | Update organization domain info and saml config | Update a domain's info for a specific organization by id, including verification status and saml configuration. requires uuid path params and supports json, form-data content types. |
| `POSTHOG_UPDATE_ORGANIZATION_DOMAIN_PROPERTIES` | Update organization domain properties | Updates selected properties of a domain in an organization via patch request, supports various data formats but saml fields are immutable. authentication needed. |
| `POSTHOG_UPDATE_ORGANIZATION_MEMBER_BY_UUIDS` | Update organization member by uuids | Patch '/api/organizations/{id}/members/{uuid}': updates org member with user and org uuids. supports json/form/multipart. returns member data. secured by personalapikeyauth. |
| `POSTHOG_UPDATE_ORGANIZATION_MEMBER_DETAILS` | Update organization member details | Update 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 settings. |
| `POSTHOG_UPDATE_ORGANIZATION_S_PROXY_RECORD_DOMAIN` | Update organization s proxy record domain | Update a proxy record's domain details for a specified organization and proxy record id using put. requires organization and record ids, supports json, form, and multipart data. responses include status and timestamps. auth required. |
| `POSTHOG_UPDATE_PARTIAL_PROJECT_COHORT_DETAILS` | Update partial project cohort details | Update partial cohort details for a specific project. requires a cohort id and project id, supports json, form data, and accepts patch changes like name or description. returns updated cohort data. auth required. |
| `POSTHOG_UPDATE_PARTIAL_ROLE_DETAILS_IN_ORGANIZATION` | Update partial role details in organization | Patch /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 organization and role. supports json, form, and multipart data. |
| `POSTHOG_UPDATE_PARTIAL_SUBSCRIPTION_DETAILS` | Update partial subscription details | Patch /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. |
| `POSTHOG_UPDATE_PARTIAL_SURVEY_DETAILS` | Update partial survey details | Update partial survey details by patch to /api/projects/{project id}/surveys/{id}/ with uuid. edit attributes like name, type, questions, targeting, and flags. needs personalapikeyauth for write access. |
| `POSTHOG_UPDATE_PERSON_PROPERTIES` | Update person properties | Request 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. |
| `POSTHOG_UPDATE_PERSON_PROPERTY_ENDPOINT` | Update person property endpoint | This endpoint allows for reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons. |
| `POSTHOG_UPDATE_PIPELINE_DESTINATION_CONFIG` | Update pipeline destination config | Update the configuration for a pipeline destination in a project. accepts a json, form-urlencoded, or multipart data payload to modify plugin settings by providing project and config ids. requires plugin:write authority. responds with updated data. |
| `POSTHOG_UPDATE_PIPELINE_FRONTEND_APP_CONFIG` | Update pipeline frontend app config | Update configuration for a specific pipeline frontend app by providing its id and the project id. configure details like activation, order, and optional parameters via json or form data. authentication required. |
| `POSTHOG_UPDATE_PIPELINE_PLUGIN_CONFIG` | Update pipeline plugin config | Update a project-specific pipeline plugin configuration by supplying the project id and config id. this put request expects details like plugin state, order, and more in json, form data, or url-encoded format. authentication is required. |
| `POSTHOG_UPDATE_PIPELINE_TRANSFORMATION_CONFIG` | Update pipeline transformation config | Update a pipeline transformation configuration for a specific project and config id. requires project id and config id in the path and json payload. supports plugin activation and order changes. |
| `POSTHOG_UPDATE_PLUGIN_CONFIG_FOR_PROJECT` | Update plugin config for project | Update a plugin config's partial details in a project by its id using patch. requires project id, config id. accepts json/form data. authenticated with personalapikeyauth. returns updated config. |
| `POSTHOG_UPDATE_PROJECT_ACTION_BY_ID` | Update project action by id | Put 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. |
| `POSTHOG_UPDATE_PROJECT_ACTION_WITH_PARTIAL_DATA` | Update project action with partial data | Update 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. requires 'action:write' permission. |
| `POSTHOG_UPDATE_PROJECT_COHORT_DETAILS` | Update project cohort details | Update 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. |
| `POSTHOG_UPDATE_PROJECT_DASHBOARD_DETAILS` | Update project dashboard details | Endpoint to update an existing dashboard within a project. provide `project id` and `dashboard id` in path, send json or form data with dashboard details. requires `dashboard:write` permission; responds with updated dashboard data. |
| `POSTHOG_UPDATE_PROJECT_EARLY_ACCESS_FEATURE` | Update project early access feature | Update a specific early access feature of a project by providing the `project id` and feature `id` (uuid). requires a json body with feature details and responds with the updated status. authentication via personalapikeyauth is mandatory. |
| `POSTHOG_UPDATE_PROJECT_EVENT_DEFINITION` | Update project event definition | Update 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. |
| `POSTHOG_UPDATE_PROJECT_GROUP_TYPE_METADATA` | Update project group type metadata | Patch /api/projects/{project id}/groups types/update metadata: update group type metadata for a specific project using its project id. can modify name singular and name plural fields up to 400 characters each. |
| `POSTHOG_UPDATE_PROJECT_INSIGHT_DETAILS` | Update project insight details | Endpoint "/api/projects/{project id}/insights/{id}/" allows for updating an insight's details for a given project and insight id, supporting json and csv formats, with fields like name, query, and various timestamps. requires insight write permission. |
| `POSTHOG_UPDATE_PROJECT_MEMBER_ROLE_BY_UUID` | Update project member role by uuid | Update 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. |
| `POSTHOG_UPDATE_PROJECT_MEMBER_S_ROLE_BY_UUID` | Update project member s role by uuid | Update explicit project membership using uuids. this put endpoint modifies a project member's role, where '1' stands for member and '8' for administrator. requires `project id` and `parent membership user uuid`. |
| `POSTHOG_UPDATE_PROJECT_NOTEBOOK_DETAILS` | Update project notebook details | The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement. |
| `POSTHOG_UPDATE_PROJECT_PIPELINE_DESTINATION_CONFIG` | Update project pipeline destination config | Update a project's pipeline destination config by id via patch api request. supports json/form requests, with fields like plugin & order. requires personalapikeyauth. |
| `POSTHOG_UPDATE_PROJECT_PIPELINE_TRANSFORMATION_CONFIG` | Update project pipeline transformation config | Update a specific pipeline transformation configuration for a project by providing a `project id` and configuration `id`. this patch request can modify properties like `plugin`, `enabled`, and `order`. authentication via a personal api key is required. |
| `POSTHOG_UPDATE_PROJECT_PLUGIN_CONFIGURATION` | Update project plugin configuration | Update project plugin config using its integer id and project string id; accepts json, url-encoded, or form-data. requires authentication; returns the updated config. |
| `POSTHOG_UPDATE_PROJECT_PROPERTY_DEFINITION` | Update project property definition | Update 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. |
| `POSTHOG_UPDATE_PROJECT_SESSION_RECORDING_PLAYLIST` | Update project session recording playlist | Update an existing session recording playlist for a project with the specified project id and playlist short id. requires json or form data input to modify the playlist's properties like name, description, and status. |
| `POSTHOG_UPDATE_PROJECT_SUBSCRIPTION_DETAILS` | Update project subscription details | Update a subscription for a specific project. provide project id and subscription id in the path and use mime types like application/json with fields like frequency, target type, etc. requires `subscription:write` permission. |
| `POSTHOG_UPDATE_PROJECT_SURVEY_DETAILS` | Update project survey details | The `/api/projects/{project id}/surveys/{id}/` put endpoint updates survey details in a project using survey uuid and project id, accepts json/form/multipart data, needs `survey:write` permission, and returns the updated survey. |
| `POSTHOG_UPDATE_ROLE_DETAILS_IN_ORGANIZATION` | Update role details in organization | Update 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 data. |
| `POSTHOG_UPDATE_SESSION_RECORDING_PLAYLIST_PARTIALLY` | Update session recording playlist partially | Update 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. |
| `POSTHOG_UPDATE_SPECIFIC_PROXY_RECORD_FIELDS` | Update specific proxy record fields | Patch `/api/organizations/{organization id}/proxy records/{id}/`: update specific fields of a proxy record by id within an organization. supports json, form data, and multipart. requires `organization:write` permission. returns updated proxy record. |

## Supported Triggers

None listed.

## Creating MCP Server - Stand-alone vs Composio SDK

Once connected, OpenCode can access the Posthog MCP server via Composio to run the app actions you authorize, directly from your coding workflow.

## Complete Code

None listed.

## Conclusion

### Way Forward
Now that Posthog is connected, extend your setup by connecting the other apps you already use every day, so your agent can run true cross-app workflows end to end.
- Connect Calendar to turn threads into scheduled meetings automatically.
- Connect Slack or Teams to post summaries, approvals, and alerts where your team works.
- Connect Notion, Linear, Jira, or Asana to convert requests into tickets, tasks, and docs.
- Connect Drive, Dropbox, or OneDrive to fetch, file, and share attachments without manual steps.
Start with one workflow you do repeatedly, then keep adding apps as you find new handoffs. With everything behind a single MCP endpoint, your agent can coordinate multiple tools safely and reliably in one conversation.

## How to build Posthog MCP Agent with another framework

- [ChatGPT](https://composio.dev/toolkits/posthog/framework/chatgpt)
- [OpenAI Agents SDK](https://composio.dev/toolkits/posthog/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/posthog/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/posthog/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/posthog/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/posthog/framework/codex)
- [Cursor](https://composio.dev/toolkits/posthog/framework/cursor)
- [VS Code](https://composio.dev/toolkits/posthog/framework/vscode)
- [OpenClaw](https://composio.dev/toolkits/posthog/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/posthog/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/posthog/framework/cli)
- [Google ADK](https://composio.dev/toolkits/posthog/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/posthog/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/posthog/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/posthog/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/posthog/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/posthog/framework/crew-ai)

## Related Toolkits

- [Firecrawl](https://composio.dev/toolkits/firecrawl) - Firecrawl automates large-scale web crawling and data extraction. It helps organizations efficiently gather, index, and analyze content from online sources.
- [Tavily](https://composio.dev/toolkits/tavily) - Tavily offers powerful search and data retrieval from documents, databases, and the web. It helps teams locate and filter information instantly, saving hours on research.
- [Exa](https://composio.dev/toolkits/exa) - Exa is a data extraction and search platform for gathering and analyzing information from websites, APIs, or databases. It helps teams quickly surface insights and automate data-driven workflows.
- [Serpapi](https://composio.dev/toolkits/serpapi) - SerpApi is a real-time API for structured search engine results. It lets you automate SERP data collection, parsing, and analysis for SEO and research.
- [Peopledatalabs](https://composio.dev/toolkits/peopledatalabs) - Peopledatalabs delivers B2B data enrichment and identity resolution APIs. Supercharge your apps with accurate, up-to-date business and contact data.
- [Snowflake](https://composio.dev/toolkits/snowflake) - Snowflake is a cloud data warehouse built for elastic scaling, secure data sharing, and fast SQL analytics across major clouds.
- [Amplitude](https://composio.dev/toolkits/amplitude) - Amplitude is a digital analytics platform for product and behavioral data insights. It helps teams analyze user journeys and make data-driven decisions quickly.
- [Bright Data MCP](https://composio.dev/toolkits/brightdata_mcp) - Bright Data MCP is an AI-powered web scraping and data collection platform. Instantly access public web data in real time with advanced scraping tools.
- [Browseai](https://composio.dev/toolkits/browseai) - Browseai is a web automation and data extraction platform that turns any website into an API. It's perfect for monitoring websites and retrieving structured data without manual scraping.
- [ClickHouse](https://composio.dev/toolkits/clickhouse) - ClickHouse is an open-source, column-oriented database for real-time analytics and big data processing using SQL. Its lightning-fast query performance makes it ideal for handling large datasets and delivering instant insights.
- [Coinmarketcal](https://composio.dev/toolkits/coinmarketcal) - CoinMarketCal is a community-powered crypto calendar for upcoming events, announcements, and releases. It helps traders track market-moving developments and stay ahead in the crypto space.
- [Control d](https://composio.dev/toolkits/control_d) - Control d is a customizable DNS filtering and traffic redirection platform. It helps you manage internet access, enforce policies, and monitor usage across devices and networks.
- [Databox](https://composio.dev/toolkits/databox) - Databox is a business analytics platform that connects your data from any tool and device. It helps you track KPIs, build dashboards, and discover actionable insights.
- [Databricks](https://composio.dev/toolkits/databricks) - Databricks is a unified analytics platform for big data and AI on the lakehouse architecture. It empowers data teams to collaborate, analyze, and build scalable solutions efficiently.
- [Datagma](https://composio.dev/toolkits/datagma) - Datagma delivers data intelligence and analytics for business growth and market discovery. Get actionable market insights and track competitors to inform your strategy.
- [Delighted](https://composio.dev/toolkits/delighted) - Delighted is a customer feedback platform based on the Net Promoter System®. It helps you quickly gather, track, and act on customer sentiment.
- [Dovetail](https://composio.dev/toolkits/dovetail) - Dovetail is a research analysis platform for transcript review and insight generation. It helps teams code interviews, analyze feedback, and create actionable research summaries.
- [Dub](https://composio.dev/toolkits/dub) - Dub is a short link management platform with analytics and API access. Use it to easily create, manage, and track branded short links for your business.
- [Elasticsearch](https://composio.dev/toolkits/elasticsearch) - Elasticsearch is a distributed, RESTful search and analytics engine for all types of data. It delivers fast, scalable search and powerful analytics across massive datasets.
- [Fireflies](https://composio.dev/toolkits/fireflies) - Fireflies.ai is an AI-powered meeting assistant that records, transcribes, and analyzes voice conversations. It helps teams capture call notes automatically and search or summarize meetings effortlessly.

## Frequently Asked Questions

### What are the differences in Tool Router MCP and Posthog MCP?

With a standalone Posthog MCP server, the agents and LLMs can only access a fixed set of Posthog tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Posthog and many other apps based on the task at hand, all through a single MCP endpoint.

### Can I use Tool Router MCP with OpenCode?

Yes, you can. OpenCode fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Posthog tools.

### Can I manage the permissions and scopes for Posthog while using Tool Router?

Yes, absolutely. You can configure which Posthog scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

### How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Posthog data and credentials are handled as safely as possible.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)