PostHog
Overview
Section titled “Overview”PostHog is an open-source product analytics platform that tracks user interactions and behaviors to help teams refine features, improve conversion funnels, and reduce churn. With the PostHog integration in SquadOS, your agents can capture events, manage feature flags, trigger A/B experiments, analyze cohorts, create surveys, and monitor exported data — all via API.
- Official website: https://posthog.com/
- Composio documentation: docs.composio.dev/toolkits/posthog
Authentication
Section titled “Authentication”This tool uses an API key (API_KEY) to connect.
You will need the following fields:
| Field | Required | Description |
|---|---|---|
api_key | Yes | Personal API key generated in the PostHog dashboard under Settings → Personal API Keys. |
How to get credentials
Section titled “How to get credentials”- Go to posthog.com and log in or create an account.
- Click Settings in the top-right corner.
- Scroll down to find the Personal API Keys section.
- Before generating the key, define the scopes (permissions) the application will need — restrict to the minimum required for security.
- Provide a descriptive label for your API key and click Create.
- Copy the key immediately — it is displayed only once after creation.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
PostHog. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
- Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)
How do I set up custom OAuth credentials for PostHog?
Section titled “How do I set up custom OAuth credentials for PostHog?”For a step-by-step guide on creating and configuring your own PostHog OAuth credentials with Composio, see How to create OAuth credentials for PostHog.
Available actions
Section titled “Available actions”Capture Event
Section titled “Capture Event”POSTHOG_CAPTURE_EVENT
Capture (ingest) a single analytics event into PostHog using the public ingestion API and a project API key. Use when you need to send custom events like lesson_started, quiz_completed, or any user behavior tracking. This bypasses the private /api/* endpoints and uses PostHog’s public write-only ingestion endpoint.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
event | string | Yes | Name of the event to capture (e.g., lesson_started, quiz_completed, button_clicked). |
api_key | string | Yes | Project API Key (write-only ingestion key). This is different from your personal API key and is safe to use in public contexts. |
timestamp | string | No | ISO 8601 timestamp indicating when the event occurred (e.g., 2024-05-22T17:09:29.220Z). If not provided, PostHog uses the current server time. |
properties | object | No | Optional event properties containing arbitrary metadata about the event (e.g., {'lesson_id': '42', 'score': 95}). |
distinct_id | string | Yes | Unique identifier for the user or entity. Commonly a UUID or user ID (e.g., 018daf23-89b3-7cf8-a4f1-94064c96df90 or user_123). |
ingest_host | string | No | PostHog ingestion host. Use https://us.i.posthog.com for US Cloud, https://eu.i.posthog.com for EU Cloud, or your self-hosted domain. Defaults to US Cloud. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Feature Flag
Section titled “Create Feature Flag”POSTHOG_CREATE_FEATURE_FLAG
Tool to create a new feature flag in a PostHog project. Use when you need to add feature toggles, perform gradual rollouts, or target specific user segments without deploying new code.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Unique identifier key for the feature flag (e.g., dark-mode, new-checkout-flow). Used in your code to check if the flag is enabled. Must be unique within the project. |
name | string | No | Human-readable name for the feature flag displayed in the PostHog UI. If not provided, defaults to the key value. |
tags | array | No | List of tags to organize and categorize the feature flag (e.g., ['frontend', 'experiment']). |
active | boolean | No | Whether the feature flag is active/enabled. Set to false to disable without deleting. Defaults to true. |
deleted | boolean | No | Whether the feature flag is soft-deleted. Soft-deleted flags are hidden but can be restored. |
filters | object | No | Filtering and rollout configuration. Structure: {'groups': [{'properties': [], 'rollout_percentage': 50}]}. Use rollout_percentage (0–100) for gradual rollout. If omitted, flag is enabled for all users. |
project_id | string | Yes | Project ID where the feature flag will be created. Find this via the List All Projects action or from your PostHog project settings. |
is_simple_flag | boolean | No | If true, creates a simple boolean flag (on/off). If false, enables advanced targeting and multivariate options. Defaults to true. |
ensure_experience_continuity | boolean | No | If true, ensures users see a consistent experience even if flag settings change. Useful for A/B tests. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve feature flag details
Section titled “Retrieve feature flag details”POSTHOG_GET_FEATURE_FLAG_DETAILS
Retrieve detailed information about a specific feature flag in a PostHog project, including filter configuration, rollout percentages, status, creation/modification history, associated experiments, surveys, and access configurations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | A unique integer value identifying this feature flag. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update feature flag configuration
Section titled “Update feature flag configuration”POSTHOG_UPDATE_FEATURE_FLAG
Manage feature flags with creation, reading, updating, and deletion options. Utilize PostHog’s JS library or endpoint to check flag status.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | A unique integer value identifying this feature flag. |
key | string | Yes | Key of the feature flag. |
name | string | No | Contains the description for the flag (field name name kept for backwards-compatibility). |
tags | array | No | Tags for the feature flag. |
active | boolean | No | Whether the flag is active. |
deleted | boolean | No | Whether the flag is deleted. |
filters | object | No | Filtering and rollout configuration. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
rollout_percentage | integer | No | Rollout percentage (0–100). |
ensure_experience_continuity | boolean | No | Ensures consistent user experience. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Bulk delete feature flags
Section titled “Bulk delete feature flags”POSTHOG_BULK_DELETE_FEATURE_FLAGS
Bulk delete feature flags by filter criteria or explicit IDs. Accepts either filters (same filter params as list endpoint: search, active, type, etc.) or ids (explicit list of flag IDs). Returns operation status and count of deleted flags. Use @current as project_id for the current project context.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
ids | array | No | Explicit list of feature flag IDs to delete. Mutually exclusive with filters. |
filters | object | No | Filter criteria to select feature flags for deletion. Supports the same filter parameters as the list endpoint. Mutually exclusive with ids. |
project_id | string | Yes | Project ID of the project you’re trying to access. Use @current for the current project or provide the numeric project ID. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create project insights with customizable parameters
Section titled “Create project insights with customizable parameters”POSTHOG_CREATE_CUSTOM_PROJECT_INSIGHTS
Create custom analytics insights for a PostHog project. Supported query types (via InsightVizNode.source.kind): TrendsQuery, FunnelsQuery, RetentionQuery, PathsQuery, StickinessQuery, LifecycleQuery, WebStatsTableQuery, WebOverviewQuery. For ad-hoc HogQL queries, use POSTHOG_CREATE_QUERY_IN_PROJECT_BY_ID instead.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Display name for the insight. |
tags | array | No | List of tags for categorizing and organizing insights (e.g., ['conversion', 'signup']). |
query | string | No | Query configuration object defining the insight type and data to analyze. Should have kind: InsightVizNode and source containing one of the 8 valid query types. |
saved | boolean | No | Whether to save this insight permanently. Set to false for temporary/unsaved insights. |
format | string | No | Response format: json or csv. Defaults to json. |
deleted | boolean | No | Soft delete flag. Set to true to mark the insight as deleted without removing it from the database. |
timezone | string | No | Timezone for displaying time-based data (e.g., UTC, America/New_York). |
favorited | boolean | No | Whether this insight is marked as a favorite for quick access. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
description | string | No | Detailed description of what this insight measures or analyzes. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve project trend insights
Section titled “Retrieve project trend insights”POSTHOG_RETRIEVE_PROJECT_TREND_INSIGHTS
Retrieves saved trend insights from a PostHog project. Returns a list of all trend insights or a specific insight by short_id. Supports pagination via limit/offset and CSV/JSON output formats.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of results to return. Use for pagination. |
format | string | No | Response format: csv or json. Default is json. |
offset | integer | No | Number of results to skip. Use for pagination. |
short_id | string | No | Short ID of a specific saved insight to retrieve. If not provided, returns all trend insights for the project. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve funnel insights in project
Section titled “Retrieve funnel insights in project”POSTHOG_GET_FUNNEL_INSIGHTS_IN_PROJECT
Execute a funnel analysis for a specific project. Requires specifying funnel steps via events or actions parameter (at least 2 steps). Returns conversion data showing how users progress through the funnel. Supports JSON/CSV output formats.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
events | array | No | List of events to include in the funnel. Each event should have id (event name), type (events), and order (step number starting from 0). At least 2 steps are required. |
format | string | No | Response format: json or csv. |
actions | array | No | List of actions to include in the funnel. Each action should have id, type (actions), and order. |
date_to | string | No | End date for the funnel analysis. Can be a date (2021-01-01) or relative (-7d, -1m, mStart, yStart). |
date_from | string | No | Start date for the funnel analysis. Can be a date or relative value. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
filter_test_accounts | boolean | No | Whether to filter out internal and test accounts. |
funnel_window_interval | integer | No | Funnel conversion window size (used with funnel_window_interval_type). |
funnel_window_interval_type | string | No | Unit for funnel window interval: day, hour, minute, week, or month. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create new project experiment
Section titled “Create new project experiment”POSTHOG_CREATE_PROJECT_EXPERIMENT
Create a new experiment in a specific project. Requires project_id and experiment details. Returns 201 with experiment information on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the experiment. |
feature_flag_key | string | Yes | Feature flag key for the experiment. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
description | string | No | Description of the experiment. |
start_date | string | No | Start date of the experiment. |
end_date | string | No | End date of the experiment. |
filters | string | No | Experiment filters. |
parameters | string | No | Experiment configuration parameters. |
secondary_metrics | string | No | Secondary metrics for the experiment. |
archived | boolean | No | Whether the experiment is archived. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve experiment details by ids
Section titled “Retrieve experiment details by ids”POSTHOG_GET_EXPERIMENT_DETAILS
Access detailed experiment information within a project using a unique experiment ID and project ID. Response includes dates, feature flag key, metrics, and creator details.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | A unique integer value identifying this experiment. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update experiment details
Section titled “Update experiment details”POSTHOG_UPDATE_EXPERIMENT
Update an experiment by sending a PUT request with project_id and id. Changes to name, description, dates, etc. are allowed. Requires experiment:write permission.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | A unique integer value identifying this experiment. |
feature_flag_key | string | Yes | Feature Flag Key (required for experiment update). |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
name | string | No | Name of the experiment. |
description | string | No | Description of the experiment. |
start_date | string | No | Start date of the experiment. |
end_date | string | No | End date of the experiment. |
parameters | string | No | Experiment parameters. |
secondary_metrics | string | No | Secondary metrics. |
archived | boolean | No | Whether the experiment is archived. |
exposure_cohort | integer | No | Exposure cohort ID. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create project cohorts
Section titled “Create project cohorts”POSTHOG_CREATE_PROJECT_COHORT
Create cohorts for a specified project. Supports dynamic cohorts (via groups or filters) and static ones (is_static: true). Returns 201 with cohort data on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the cohort. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
groups | string | No | Groups defining cohort criteria for dynamic cohorts. |
filters | string | No | Filters for the cohort. |
is_static | boolean | No | Set to true for static cohorts. |
description | string | No | Description of the cohort. |
deleted | boolean | No | Soft delete the cohort. |
query | string | No | Query for the cohort. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve project cohorts with pagination
Section titled “Retrieve project cohorts with pagination”POSTHOG_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 cohort:read permissions.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of results to return per page. |
offset | integer | No | The initial index from which to return the results. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve person details by id
Section titled “Retrieve person details by id”POSTHOG_RETRIEVE_PERSON_DETAILS_BY_ID
This endpoint is used to read and delete persons. For creating or updating, use the capture API with $set and $unset properties, or SDKs.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A unique UUID value identifying this person. |
format | string | No | Response format: csv or json. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update person properties
Section titled “Update person properties”POSTHOG_UPDATE_PERSON_PROPERTIES
The request data’s properties will be updated on a person using a $set event, affecting only listed properties without deletion or other changes. For property removal, use the delete_property endpoint.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Identifier of the person. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
properties | string | No | Properties to update in JSON format. |
name | string | No | Name of the person. |
uuid | string | No | UUID of the person. |
format | string | No | Response format: csv or json. |
distinct_ids | array | No | Distinct IDs associated with the person. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create project surveys with questions and targets
Section titled “Create project surveys with questions and targets”POSTHOG_CREATE_PROJECT_SURVEY
Create surveys in a project by providing a project ID and details like type, questions, and targets. Supports question types: open-ended, link, rating, and multiple choice, each with configurable branching logic.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the survey. |
type | string | Yes | Survey type: popover, widget, or api. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
questions | string | No | Array of survey questions. Each question must be of type open, link, rating, single_choice, or multiple_choice, with configurable branching logic. |
description | string | No | Description of the survey. |
start_date | string | No | Start date of the survey. |
end_date | string | No | End date of the survey. |
linked_flag_id | integer | No | ID of the feature flag linked to the survey. |
targeting_flag_id | integer | No | ID of the targeting flag. |
responses_limit | integer | No | Maximum number of responses allowed. |
archived | boolean | No | Whether the survey is archived. |
appearance | string | No | Appearance configuration for the survey. |
conditions | string | No | Display conditions. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve survey details with uuid and project id
Section titled “Retrieve survey details with uuid and project id”POSTHOG_RETRIEVE_SURVEY_DETAILS_WITH_UUID_AND_PROJECT_ID
Retrieve survey details using a survey UUID and associated project ID. Returns survey name, type, linked flags, targeting flags, creator info, and questions with branching logic descriptions.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A UUID string identifying this survey. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve survey responses count by project id
Section titled “Retrieve survey responses count by project id”POSTHOG_RETRIEVE_SURVEY_RESPONSES_COUNT_BY_PROJECT_ID
Retrieve the count of survey responses for a specific project by its ID. Returns details like the survey type, linked flags, and creator info.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Summarize survey responses
Section titled “Summarize survey responses”POSTHOG_SUMMARIZE_SURVEY_RESPONSES
Tool to generate an AI-powered summary of survey responses for a specific question. Use when you need to analyze and summarize feedback from survey respondents for a particular question.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A UUID string identifying this survey. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
question_index | integer | Yes | The index of the question to summarize responses for (0-based index). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create project dashboard
Section titled “Create project dashboard”POSTHOG_CREATE_PROJECT_DASHBOARD
The POST endpoint creates a dashboard within a project using a project_id. Returns HTTP 201 with dashboard details on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the dashboard. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
tags | array | No | List of tags for categorizing and organizing the dashboard (e.g., ['analytics', 'revenue', 'weekly']). |
description | string | No | Description of the dashboard. |
pinned | boolean | No | Whether the dashboard is pinned. |
deleted | boolean | No | Whether the dashboard is deleted. |
filters | string | No | Dashboard-level filters as a JSON object (e.g., {'date_from': '-7d', 'date_to': null}). |
use_template | string | No | Template ID to use for creating the dashboard. |
use_dashboard | integer | No | Dashboard ID to duplicate. |
restriction_level | integer | No | Access control restriction level: 21 (everyone in project), 37 (only creator). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve specific project dashboard details
Section titled “Retrieve specific project dashboard details”POSTHOG_RETRIEVE_SPECIFIC_PROJECT_DASHBOARD_DETAILS
Retrieve details of a specific dashboard within a project. Requires a dashboard ID and project ID. Returns information such as dashboard properties, owner, and access levels.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | A unique integer value identifying this dashboard. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create session recording playlists
Section titled “Create session recording playlists”POSTHOG_CREATE_SESSION_RECORDING_PLAYLIST
Create playlists of session recordings for a specified project. Supports dynamic filter-based playlists (type: filters) or manually curated recording collections (type: collection).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the session recording playlist. |
type | string | Yes | Playlist type: filters (dynamic, filter-based) or collection (manually curated recordings). |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
pinned | boolean | No | Whether the playlist should be pinned to the top of the playlist list. |
deleted | boolean | No | Soft deletion flag — set to true to mark the playlist as deleted. |
filters | string | No | Filter configuration for filters type playlists. Can include events, duration, date ranges, actions, and complex filter combinations. |
description | string | No | Optional description explaining the purpose or content of this playlist. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve session recording details
Section titled “Retrieve session recording details”POSTHOG_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.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A UUID string identifying this session recording. |
project_id | string | Yes | Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create batch export
Section titled “Create batch export”POSTHOG_CREATE_BATCH_EXPORT
Create a new batch export to automatically export PostHog data to external destinations like S3, BigQuery, or Snowflake. Use when you need to set up scheduled data exports with configurable intervals and destination-specific settings.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Human-readable name for this batch export. |
interval | string | Yes | How frequently the batch export should run: hour, day, week, or every 5 minutes. |
destination | object | Yes | Configuration specifying where and how data should be exported. |
project_id | string | Yes | Project ID (also called environment ID) where the batch export will be created. Find this via /api/projects/. |
model | string | No | Data model to export: events, persons, or sessions. |
end_at | string | No | ISO 8601 timestamp for when exports should stop (e.g., 2024-12-31T23:59:59Z). |
paused | boolean | No | Whether to create the batch export in a paused state. Defaults to false. |
schema | object | No | Custom schema configuration defining which fields to export. |
filters | object | No | Filter configuration to specify which data to export. |
start_at | string | No | ISO 8601 timestamp for when exports should start. |
timezone | string | No | Timezone for scheduling exports (e.g., America/New_York, UTC). |
hogql_query | string | No | Optional HogQL query to filter or transform the exported data. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve user profile and team details
Section titled “Retrieve user profile and team details”POSTHOG_RETRIEVE_USER_PROFILE_AND_TEAM_DETAILS
Fetch user profile info including team, organization, and notifications. Non-staff users can only retrieve their own profile using @me as the uuid parameter. Staff users can retrieve any user’s profile using their actual UUID. Returns JSON with name, email, teams, organizations, and status.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
uuid | string | Yes | The user identifier. Use @me to retrieve the current authenticated user’s profile (recommended for non-staff users). Staff users can use an actual UUID to retrieve other users’ profiles. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |