Project API Key*
••••••••
Personal API Key*
••••••••
Project ID*
Enter your PostHog project ID
Event Name*
e.g., page_view, button_clicked
Distinct ID*
Unique identifier for the user
Properties (JSON)
{"key": "value"}
Timestamp (ISO 8601)
2024-01-01T12:00:00Z
Capture Event (posthog_capture_event)
Capture a single event in PostHog. Use this to track user actions, page views, or custom events.
Input
Parameter Type Required Description projectApiKeystring Yes PostHog Project API Key (public token for event ingestion) regionstring No PostHog region: us (default) or eu eventstring Yes The name of the event to capture (e.g., "page_view", "button_clicked") distinctIdstring Yes Unique identifier for the user or device. Can be user ID, device ID, or anonymous ID propertiesstring No JSON string of event properties (e.g., {"button_name": "signup", "page": "homepage"}) timestampstring No ISO 8601 timestamp for when the event occurred. If not provided, uses current time
Output
Refer to the block outputs for this operation.
Project API Key*
••••••••
Personal API Key*
••••••••
Project ID*
Enter your PostHog project ID
Batch Events (JSON Array)*
[{"event": "page_view", "distinct_id": "user123", "properties": {...}}]
Batch Events (posthog_batch_events)
Capture multiple events at once in PostHog. Use this for bulk event ingestion to improve performance.
Input
Parameter Type Required Description projectApiKeystring Yes PostHog Project API Key (public token for event ingestion) regionstring No PostHog region: us (default) or eu batchstring Yes JSON array of events to capture. Each event should have: event, distinct_id, and optional properties, timestamp. Example: [{"event": "page_view", "distinct_id": "user123", "properties": {"page": "/"}}]
Output
Parameter Type Description statusstring Status message indicating whether the batch was captured successfully
Distinct ID Filter
user123
List Persons (posthog_list_persons)
List persons (users) in PostHog. Returns user profiles with their properties and distinct IDs.
Input
Parameter Type Required Description personalApiKeystring Yes PostHog Personal API Key (for authenticated API access) regionstring No PostHog region: us (default) or eu projectIdstring Yes PostHog Project ID limitnumber No Number of persons to return (default: 100, max: 100) offsetnumber No Number of persons to skip for pagination searchstring No Search persons by email, name, or distinct ID distinctIdstring No Filter by specific distinct_id
Output
Parameter Type Description idstring Person ID namestring Person name distinct_idsarray All distinct IDs associated with this person propertiesobject Person properties created_atstring When the person was first seen
Person ID*
Person ID or UUID
Get Person (posthog_get_person)
Get detailed information about a specific person in PostHog by their ID or UUID.
Input
Parameter Type Required Description personalApiKeystring Yes PostHog Personal API Key (for authenticated API access) regionstring No PostHog region: us (default) or eu projectIdstring Yes PostHog Project ID personIdstring Yes Person ID or UUID to retrieve
Output
Parameter Type Description idstring Person ID namestring Person name distinct_idsarray All distinct IDs associated with this person propertiesobject Person properties created_atstring When the person was first seen
Person ID*
Person ID or UUID
Delete Person (posthog_delete_person)
Delete a person from PostHog. This will remove all associated events and data. Use with caution.
Input
Parameter Type Required Description personalApiKeystring Yes PostHog Personal API Key (for authenticated API access) regionstring No PostHog region: us (default) or eu projectIdstring Yes PostHog Project ID personIdstring Yes Person ID or UUID to delete
Output
Refer to the block outputs for this operation.
Query*
HogQL query or JSON object
Query Values (JSON)
{"param1": "value1"}
Run Query (HogQL) (posthog_query)
Execute a HogQL query in PostHog. HogQL is PostHog
Input
Parameter Type Required Description personalApiKeystring Yes PostHog Personal API Key (for authenticated API access) regionstring No PostHog region: us (default) or eu projectIdstring Yes PostHog Project ID querystring Yes HogQL query to execute. Example: {"kind": "HogQLQuery", "query": "SELECT event, count() FROM events WHERE timestamp > now() - INTERVAL 1 DAY GROUP BY event"} Examplestring No No description valuesstring No Optional JSON string of parameter values for parameterized queries. Example: {"user_id": "123"} Examplestring No No description
Output
Refer to the block outputs for this operation.
List Insights (posthog_list_insights)
List all insights in a PostHog project. Returns insight configurations, filters, and metadata.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") limitnumber No Number of results to return per page (default: 100) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description countnumber Total number of insights in the project nextstring URL for the next page of results previousstring URL for the previous page of results idnumber Unique identifier for the insight namestring Name of the insight descriptionstring Description of the insight filtersobject Filter configuration for the insight queryobject Query configuration for the insight created_atstring ISO timestamp when insight was created created_byobject User who created the insight last_modified_atstring ISO timestamp when insight was last modified last_modified_byobject User who last modified the insight savedboolean Whether the insight is saved
Get Insight (posthog_get_insight)
Get a specific insight by ID from PostHog. Returns detailed insight configuration, filters, and metadata.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID insightIdstring Yes The insight ID to retrieve regionstring No PostHog cloud region: "us" or "eu" (default: "us")
Output
Parameter Type Description idnumber Unique identifier for the insight namestring Name of the insight descriptionstring Description of the insight filtersobject Filter configuration for the insight queryobject Query configuration for the insight created_atstring ISO timestamp when insight was created created_byobject User who created the insight last_modified_atstring ISO timestamp when insight was last modified last_modified_byobject User who last modified the insight savedboolean Whether the insight is saved dashboardsarray IDs of dashboards this insight appears on tagsarray Tags associated with the insight
Description
Enter description
Filters (JSON)
{"groups": [...]}
Query (JSON)
{"kind": "HogQLQuery", "query": "SELECT ..."}
Dashboard IDs (comma-separated)
123, 456, 789
Tags (comma-separated)
analytics, revenue, important
Create Insight (posthog_create_insight)
Create a new insight in PostHog. Requires insight name and configuration filters or query.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") namestring No Name for the insight (optional - PostHog will generate a derived name if not provided) descriptionstring No Description of the insight filtersstring No JSON string of filter configuration for the insight querystring No JSON string of query configuration for the insight dashboardsstring No Comma-separated list of dashboard IDs to add this insight to tagsstring No Comma-separated list of tags for the insight
Output
Parameter Type Description idnumber Unique identifier for the created insight namestring Name of the insight descriptionstring Description of the insight filtersobject Filter configuration for the insight queryobject Query configuration for the insight created_atstring ISO timestamp when insight was created created_byobject User who created the insight last_modified_atstring ISO timestamp when insight was last modified savedboolean Whether the insight is saved dashboardsarray IDs of dashboards this insight appears on
List Dashboards (posthog_list_dashboards)
List all dashboards in a PostHog project. Returns dashboard configurations, tiles, and metadata.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") limitnumber No Number of results to return per page (default: 100) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description countnumber Total number of dashboards in the project nextstring URL for the next page of results previousstring URL for the previous page of results idnumber Unique identifier for the dashboard namestring Name of the dashboard descriptionstring Description of the dashboard pinnedboolean Whether the dashboard is pinned created_atstring ISO timestamp when dashboard was created created_byobject User who created the dashboard last_modified_atstring ISO timestamp when dashboard was last modified last_modified_byobject User who last modified the dashboard tilesarray Tiles/widgets on the dashboard filtersobject Global filters for the dashboard
Dashboard ID*
Dashboard ID
Get Dashboard (posthog_get_dashboard)
Get a specific dashboard by ID from PostHog. Returns detailed dashboard configuration, tiles, and metadata.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID dashboardIdstring Yes The dashboard ID to retrieve regionstring No PostHog cloud region: "us" or "eu" (default: "us")
Output
Parameter Type Description idnumber Unique identifier for the dashboard namestring Name of the dashboard descriptionstring Description of the dashboard pinnedboolean Whether the dashboard is pinned created_atstring ISO timestamp when dashboard was created created_byobject User who created the dashboard last_modified_atstring ISO timestamp when dashboard was last modified last_modified_byobject User who last modified the dashboard tilesarray Tiles/widgets on the dashboard with their configurations filtersobject Global filters applied to the dashboard tagsarray Tags associated with the dashboard
List Actions (posthog_list_actions)
List all actions in a PostHog project. Returns action definitions, steps, and metadata.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") limitnumber No Number of results to return per page (default: 100) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description countnumber Total number of actions in the project nextstring URL for the next page of results previousstring URL for the previous page of results idnumber Unique identifier for the action namestring Name of the action descriptionstring Description of the action tagsarray Tags associated with the action post_to_slackboolean Whether to post this action to Slack slack_message_formatstring Format string for Slack messages stepsarray Steps that define the action created_atstring ISO timestamp when action was created created_byobject User who created the action deletedboolean Whether the action is deleted is_calculatingboolean Whether the action is being calculated
List Cohorts (posthog_list_cohorts)
List all cohorts in a PostHog project. Returns cohort definitions, filters, and user counts.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") limitnumber No Number of results to return per page (default: 100) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description countnumber Number of users in the cohort nextstring URL for the next page of results previousstring URL for the previous page of results idnumber Unique identifier for the cohort namestring Name of the cohort descriptionstring Description of the cohort groupsarray Groups that define the cohort deletedboolean Whether the cohort is deleted filtersobject Filter configuration for the cohort queryobject Query configuration for the cohort created_atstring ISO timestamp when cohort was created created_byobject User who created the cohort is_calculatingboolean Whether the cohort is being calculated last_calculationstring ISO timestamp of last calculation errors_calculatingnumber Number of errors during calculation
Get Cohort (posthog_get_cohort)
Get a specific cohort by ID from PostHog. Returns detailed cohort definition, filters, and user count.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID cohortIdstring Yes The cohort ID to retrieve regionstring No PostHog cloud region: "us" or "eu" (default: "us")
Output
Parameter Type Description idnumber Unique identifier for the cohort namestring Name of the cohort descriptionstring Description of the cohort groupsarray Groups that define the cohort deletedboolean Whether the cohort is deleted filtersobject Filter configuration for the cohort queryobject Query configuration for the cohort created_atstring ISO timestamp when cohort was created created_byobject User who created the cohort is_calculatingboolean Whether the cohort is being calculated last_calculationstring ISO timestamp of last calculation errors_calculatingnumber Number of errors during calculation countnumber Number of users in the cohort is_staticboolean Whether the cohort is static
Query
HogQL query or JSON object
Description
Enter description
Filters (JSON)
{"groups": [...]}
Groups (JSON Array)
[{"properties": [...]}]
Create Cohort (posthog_create_cohort)
Create a new cohort in PostHog. Requires cohort name and filter or query configuration.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") namestring No Name for the cohort (optional - PostHog will use "Untitled cohort" if not provided) descriptionstring No Description of the cohort filtersstring No JSON string of filter configuration for the cohort querystring No JSON string of query configuration for the cohort is_staticboolean No Whether the cohort is static (default: false) groupsstring No JSON string of groups that define the cohort
Output
Parameter Type Description idnumber Unique identifier for the created cohort namestring Name of the cohort descriptionstring Description of the cohort groupsarray Groups that define the cohort deletedboolean Whether the cohort is deleted filtersobject Filter configuration for the cohort queryobject Query configuration for the cohort created_atstring ISO timestamp when cohort was created created_byobject User who created the cohort is_calculatingboolean Whether the cohort is being calculated countnumber Number of users in the cohort is_staticboolean Whether the cohort is static
List Annotations (posthog_list_annotations)
List all annotations in a PostHog project. Returns annotation content, timestamps, and associated insights.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") limitnumber No Number of results to return per page (default: 100) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description countnumber Total number of annotations in the project nextstring URL for the next page of results previousstring URL for the previous page of results idnumber Unique identifier for the annotation contentstring Content/text of the annotation date_markerstring ISO timestamp marking when the annotation applies created_atstring ISO timestamp when annotation was created updated_atstring ISO timestamp when annotation was last updated created_byobject User who created the annotation dashboard_itemnumber ID of dashboard item this annotation is attached to insight_short_idstring Short ID of the insight this annotation is attached to insight_namestring Name of the insight this annotation is attached to scopestring Scope of the annotation (project or dashboard)
Content*
Annotation content
Date Marker (ISO 8601)*
2024-01-01T12:00:00Z
Create Annotation (posthog_create_annotation)
Create a new annotation in PostHog. Mark important events on your graphs with date and description.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes The PostHog project ID regionstring No PostHog cloud region: "us" or "eu" (default: "us") contentstring Yes Content/text of the annotation date_markerstring Yes ISO timestamp marking when the annotation applies (e.g., "2024-01-15T10:00:00Z") scopestring No Scope of the annotation: "project" or "dashboard_item" (default: "project") dashboard_itemstring No ID of dashboard item to attach this annotation to insight_short_idstring No Short ID of the insight to attach this annotation to
Output
Parameter Type Description idnumber Unique identifier for the created annotation contentstring Content/text of the annotation date_markerstring ISO timestamp marking when the annotation applies created_atstring ISO timestamp when annotation was created updated_atstring ISO timestamp when annotation was last updated created_byobject User who created the annotation dashboard_itemnumber ID of dashboard item this annotation is attached to insight_short_idstring Short ID of the insight this annotation is attached to insight_namestring Name of the insight this annotation is attached to scopestring Scope of the annotation (project or dashboard_item)
List Feature Flags (posthog_list_feature_flags)
List all feature flags in a PostHog project
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key limitnumber No Number of results to return offsetnumber No Number of results to skip
Output
Parameter Type Description idnumber Feature flag ID namestring Feature flag name keystring Feature flag key filtersobject Feature flag filters deletedboolean Whether the flag is deleted activeboolean Whether the flag is active created_atstring Creation timestamp created_byobject Creator information is_simple_flagboolean Whether this is a simple flag rollout_percentagenumber Rollout percentage (if applicable)
Feature Flag ID*
Feature Flag ID
Get Feature Flag (posthog_get_feature_flag)
Get details of a specific feature flag
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID flagIdstring Yes The feature flag ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key
Output
Parameter Type Description idnumber Feature flag ID namestring Feature flag name keystring Feature flag key filtersobject Feature flag filters deletedboolean Whether the flag is deleted activeboolean Whether the flag is active created_atstring Creation timestamp created_byobject Creator information is_simple_flagboolean Whether this is a simple flag rollout_percentagenumber Rollout percentage (if applicable) ensure_experience_continuityboolean Whether to ensure experience continuity usage_dashboardnumber Usage dashboard ID
Description
Enter description
Flag Key*
feature_flag_key
Filters (JSON)
{"groups": [...]}
Ensure Experience Continuity
Create Feature Flag (posthog_create_feature_flag)
Create a new feature flag in PostHog
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key namestring No Feature flag name (optional - can be empty) keystring Yes Feature flag key (unique identifier) filtersstring No Feature flag filters as JSON string activeboolean No Whether the flag is active (default: true) ensureExperienceContinuityboolean No Whether to ensure experience continuity (default: false) rolloutPercentagenumber No Rollout percentage (0-100)
Output
Parameter Type Description idnumber Feature flag ID namestring Feature flag name keystring Feature flag key filtersobject Feature flag filters deletedboolean Whether the flag is deleted activeboolean Whether the flag is active created_atstring Creation timestamp created_byobject Creator information is_simple_flagboolean Whether this is a simple flag rollout_percentagenumber Rollout percentage (if applicable)
Feature Flag ID*
Feature Flag ID
Description
Enter description
Filters (JSON)
{"groups": [...]}
Ensure Experience Continuity
Update Feature Flag (posthog_update_feature_flag)
Update an existing feature flag in PostHog
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID flagIdstring Yes The feature flag ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key namestring No Feature flag name keystring No Feature flag key (unique identifier) filtersstring No Feature flag filters as JSON string activeboolean No Whether the flag is active ensureExperienceContinuityboolean No Whether to ensure experience continuity rolloutPercentagenumber No Rollout percentage (0-100)
Output
Parameter Type Description idnumber Feature flag ID namestring Feature flag name keystring Feature flag key filtersobject Feature flag filters deletedboolean Whether the flag is deleted activeboolean Whether the flag is active created_atstring Creation timestamp created_byobject Creator information is_simple_flagboolean Whether this is a simple flag rollout_percentagenumber Rollout percentage (if applicable)
Feature Flag ID*
Feature Flag ID
Delete Feature Flag (posthog_delete_feature_flag)
Delete a feature flag from PostHog
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID flagIdstring Yes The feature flag ID to delete regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key
Output
Parameter Type Description successboolean Whether the deletion was successful
Project API Key*
••••••••
Personal API Key*
••••••••
Project ID*
Enter your PostHog project ID
Distinct ID*
Unique identifier for the user
Groups (JSON)
{"company": "company_id_in_your_db"}
Person Properties (JSON)
{"email": "user@example.com", "plan": "enterprise"}
Group Properties (JSON)
{"plan": "enterprise", "seats": 100}
Evaluate Flags (posthog_evaluate_flags)
Evaluate feature flags for a specific user or group. This is a public endpoint that uses the project API key.
Input
Parameter Type Required Description regionstring Yes PostHog cloud region: us or eu projectApiKeystring Yes PostHog Project API Key (not personal API key) distinctIdstring Yes The distinct ID of the user to evaluate flags for groupsstring No Groups as JSON string (e.g., {"company": "company_id_in_your_db"}) personPropertiesstring No Person properties as JSON string groupPropertiesstring No Group properties as JSON string
Output
Parameter Type Description featureFlagsobject Feature flag evaluations (key-value pairs where values are boolean or string variants) featureFlagPayloadsobject Additional payloads attached to feature flags
List Experiments (posthog_list_experiments)
List all experiments in a PostHog project
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key limitnumber No Number of results to return offsetnumber No Number of results to skip
Output
Parameter Type Description idnumber Experiment ID namestring Experiment name descriptionstring Experiment description feature_flag_keystring Associated feature flag key feature_flagobject Feature flag details parametersobject Experiment parameters filtersobject Experiment filters variantsobject Experiment variants start_datestring Start date end_datestring End date created_atstring Creation timestamp created_byobject Creator information
Experiment ID*
Experiment ID
Get Experiment (posthog_get_experiment)
Get details of a specific experiment
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID experimentIdstring Yes The experiment ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key
Output
Parameter Type Description idnumber Experiment ID namestring Experiment name descriptionstring Experiment description feature_flag_keystring Associated feature flag key feature_flagobject Feature flag details parametersobject Experiment parameters filtersobject Experiment filters variantsobject Experiment variants start_datestring Start date end_datestring End date created_atstring Creation timestamp created_byobject Creator information archivedboolean Whether the experiment is archived metricsarray Primary metrics
Description
Enter description
Filters (JSON)
{"groups": [...]}
Feature Flag Key*
experiment_flag_key
Parameters (JSON)
{"minimum_detectable_effect": 5}
Variants (JSON)
{"control": 50, "test": 50}
Start Date (ISO 8601)
2024-01-01T00:00:00Z
End Date (ISO 8601)
2024-12-31T23:59:59Z
Create Experiment (posthog_create_experiment)
Create a new experiment in PostHog
Input
Parameter Type Required Description projectIdstring Yes The PostHog project ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key namestring No Experiment name (optional) descriptionstring No Experiment description featureFlagKeystring Yes Feature flag key to use for the experiment parametersstring No Experiment parameters as JSON string filtersstring No Experiment filters as JSON string variantsstring No Experiment variants as JSON string startDatestring No Experiment start date (ISO format) endDatestring No Experiment end date (ISO format)
Output
Parameter Type Description idnumber Experiment ID namestring Experiment name descriptionstring Experiment description feature_flag_keystring Associated feature flag key feature_flagobject Feature flag details parametersobject Experiment parameters filtersobject Experiment filters variantsobject Experiment variants start_datestring Start date end_datestring End date created_atstring Creation timestamp created_byobject Creator information
List Surveys (posthog_list_surveys)
List all surveys in a PostHog project. Surveys allow you to collect feedback from users.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes PostHog Project ID regionstring No PostHog cloud region: us or eu (default: us) limitnumber No Number of results to return (default: 100) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description idstring Survey ID namestring Survey name descriptionstring Survey description typestring Survey type (popover or api) questionsarray Survey questions created_atstring Creation timestamp start_datestring Survey start date end_datestring Survey end date
Get Survey (posthog_get_survey)
Get details of a specific survey in PostHog by ID.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes PostHog Project ID surveyIdstring Yes Survey ID to retrieve regionstring No PostHog cloud region: us or eu (default: us)
Output
Parameter Type Description idstring Survey ID namestring Survey name descriptionstring Survey description typestring Survey type (popover or api) questionsarray Survey questions appearanceobject Survey appearance configuration conditionsobject Survey display conditions created_atstring Creation timestamp created_byobject Creator information start_datestring Survey start date end_datestring Survey end date archivedboolean Whether survey is archived
Description
Enter description
Questions (JSON Array)*
[{"type": "open", "question": "What do you think?"}]
Start Date (ISO 8601)
2024-01-01T00:00:00Z
End Date (ISO 8601)
2024-12-31T23:59:59Z
Appearance (JSON)
{"backgroundColor": "#ffffff", "position": "right"}
Conditions (JSON)
{"url": "contains", "value": "/checkout"}
Targeting Flag Filters (JSON)
{"groups": [...]}
Linked Feature Flag ID
Feature flag ID
Create Survey (posthog_create_survey)
Create a new survey in PostHog. Supports question types: Basic (open), Link, Rating, and Multiple Choice.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes PostHog Project ID regionstring No PostHog cloud region: us or eu (default: us) namestring No Survey name (optional) descriptionstring No Survey description typestring No Survey type: popover (in-app) or api (custom implementation) (default: popover) questionsstring Yes JSON string of survey questions array. Each question must have type (open/link/rating/multiple_choice) and question text. Rating questions can have scale (1-10), lowerBoundLabel, upperBoundLabel. Multiple choice questions need choices array. Link questions can have buttonText. startDatestring No Survey start date in ISO 8601 format endDatestring No Survey end date in ISO 8601 format appearancestring No JSON string of appearance configuration (colors, position, etc.) conditionsstring No JSON string of display conditions (URL matching, etc.) targetingFlagFiltersstring No JSON string of feature flag filters for targeting linkedFlagIdstring No Feature flag ID to link to this survey responsesLimitnumber No Maximum number of responses to collect
Output
Parameter Type Description idstring Survey ID namestring Survey name descriptionstring Survey description typestring Survey type (popover or api) questionsarray Survey questions created_atstring Creation timestamp start_datestring Survey start date
Description
Enter description
Questions (JSON Array)
[{"type": "open", "question": "What do you think?"}]
Start Date (ISO 8601)
2024-01-01T00:00:00Z
End Date (ISO 8601)
2024-12-31T23:59:59Z
Appearance (JSON)
{"backgroundColor": "#ffffff", "position": "right"}
Conditions (JSON)
{"url": "contains", "value": "/checkout"}
Targeting Flag Filters (JSON)
{"groups": [...]}
Linked Feature Flag ID
Feature flag ID
Update Survey (posthog_update_survey)
Update an existing survey in PostHog. Can modify questions, appearance, conditions, and other settings.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes PostHog Project ID surveyIdstring Yes Survey ID to update regionstring No PostHog cloud region: us or eu (default: us) namestring No Survey name descriptionstring No Survey description typestring No Survey type: popover or api questionsstring No JSON string of survey questions array. Each question must have type (open/link/rating/multiple_choice) and question text. startDatestring No Survey start date in ISO 8601 format endDatestring No Survey end date in ISO 8601 format appearancestring No JSON string of appearance configuration (colors, position, etc.) conditionsstring No JSON string of display conditions (URL matching, etc.) targetingFlagFiltersstring No JSON string of feature flag filters for targeting linkedFlagIdstring No Feature flag ID to link to this survey responsesLimitnumber No Maximum number of responses to collect archivedboolean No Archive or unarchive the survey
Output
Parameter Type Description idstring Survey ID namestring Survey name descriptionstring Survey description typestring Survey type (popover or api) questionsarray Survey questions created_atstring Creation timestamp start_datestring Survey start date end_datestring Survey end date
List Session Recordings (posthog_list_session_recordings)
List session recordings in a PostHog project. Session recordings capture user interactions with your application.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes PostHog Project ID regionstring No PostHog cloud region: us or eu (default: us) limitnumber No Number of results to return (default: 50) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description idstring Recording ID distinct_idstring User distinct ID viewedboolean Whether recording has been viewed recording_durationnumber Recording duration in seconds active_secondsnumber Active time in seconds inactive_secondsnumber Inactive time in seconds start_timestring Recording start timestamp end_timestring Recording end timestamp click_countnumber Number of clicks keypress_countnumber Number of keypresses console_log_countnumber Number of console logs console_warn_countnumber Number of console warnings console_error_countnumber Number of console errors
Recording ID*
Session Recording ID
Get Session Recording (posthog_get_session_recording)
Get details of a specific session recording in PostHog by ID.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes PostHog Project ID recordingIdstring Yes Session recording ID to retrieve regionstring No PostHog cloud region: us or eu (default: us)
Output
Parameter Type Description idstring Recording ID distinct_idstring User distinct ID viewedboolean Whether recording has been viewed recording_durationnumber Recording duration in seconds active_secondsnumber Active time in seconds inactive_secondsnumber Inactive time in seconds start_timestring Recording start timestamp end_timestring Recording end timestamp click_countnumber Number of clicks keypress_countnumber Number of keypresses console_log_countnumber Number of console logs console_warn_countnumber Number of console warnings console_error_countnumber Number of console errors start_urlstring Starting URL of the recording personobject Person information
List Recording Playlists (posthog_list_recording_playlists)
List session recording playlists in a PostHog project. Playlists allow you to organize and curate session recordings.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key projectIdstring Yes PostHog Project ID regionstring No PostHog cloud region: us or eu (default: us) limitnumber No Number of results to return (default: 100) offsetnumber No Number of results to skip for pagination
Output
Parameter Type Description idstring Playlist ID short_idstring Playlist short ID namestring Playlist name descriptionstring Playlist description created_atstring Creation timestamp created_byobject Creator information deletedboolean Whether playlist is deleted filtersobject Playlist filters last_modified_atstring Last modification timestamp last_modified_byobject Last modifier information
List Event Definitions (posthog_list_event_definitions)
List all event definitions in a PostHog project. Event definitions represent tracked events with metadata like descriptions, tags, and usage statistics.
Input
Parameter Type Required Description projectIdstring Yes PostHog Project ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key limitnumber No Number of results to return per page (default: 100) offsetnumber No The initial index from which to return results searchstring No Search term to filter event definitions by name
Output
Parameter Type Description countnumber Total number of event definitions nextstring URL for the next page of results previousstring URL for the previous page of results idstring Unique identifier for the event definition namestring Event name descriptionstring Event description tagsarray Tags associated with the event volume_30_daynumber Number of events received in the last 30 days query_usage_30_daynumber Number of times this event was queried in the last 30 days created_atstring ISO timestamp when the event was created last_seen_atstring ISO timestamp when the event was last seen updated_atstring ISO timestamp when the event was updated
Event Definition ID*
Event Definition ID
Get Event Definition (posthog_get_event_definition)
Get details of a specific event definition in PostHog. Returns comprehensive information about the event including metadata, usage statistics, and verification status.
Input
Parameter Type Required Description projectIdstring Yes PostHog Project ID eventDefinitionIdstring Yes Event Definition ID to retrieve regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key
Output
Parameter Type Description idstring Unique identifier for the event definition namestring Event name descriptionstring Event description tagsarray Tags associated with the event volume_30_daynumber Number of events received in the last 30 days query_usage_30_daynumber Number of times this event was queried in the last 30 days created_atstring ISO timestamp when the event was created last_seen_atstring ISO timestamp when the event was last seen updated_atstring ISO timestamp when the event was updated updated_byobject User who last updated the event verifiedboolean Whether the event has been verified verified_atstring ISO timestamp when the event was verified
Event Definition ID*
Event Definition ID
Description
Enter description
Tags (comma-separated)
tag1, tag2, tag3
Update Event Definition (posthog_update_event_definition)
Update an event definition in PostHog. Can modify description, tags, and verification status to maintain clean event schemas.
Input
Parameter Type Required Description projectIdstring Yes PostHog Project ID eventDefinitionIdstring Yes Event Definition ID to update regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key descriptionstring No Updated description for the event tagsstring No Comma-separated list of tags to associate with the event verifiedboolean No Whether to mark the event as verified
Output
Parameter Type Description idstring Unique identifier for the event definition namestring Event name descriptionstring Updated event description tagsarray Updated tags associated with the event volume_30_daynumber Number of events received in the last 30 days query_usage_30_daynumber Number of times this event was queried in the last 30 days created_atstring ISO timestamp when the event was created last_seen_atstring ISO timestamp when the event was last seen updated_atstring ISO timestamp when the event was updated updated_byobject User who last updated the event verifiedboolean Whether the event has been verified verified_atstring ISO timestamp when the event was verified
Operation
List Property Definitions
List Property Definitions (posthog_list_property_definitions)
List all property definitions in a PostHog project. Property definitions represent tracked properties with metadata like descriptions, tags, types, and usage statistics.
Input
Parameter Type Required Description projectIdstring Yes PostHog Project ID regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key limitnumber No Number of results to return per page (default: 100) offsetnumber No The initial index from which to return results searchstring No Search term to filter property definitions by name typestring No Filter by property type: event, person, or group
Output
Parameter Type Description countnumber Total number of property definitions nextstring URL for the next page of results previousstring URL for the previous page of results idstring Unique identifier for the property definition namestring Property name descriptionstring Property description tagsarray Tags associated with the property is_numericalboolean Whether the property is numerical is_seen_on_filtered_eventsboolean Whether the property is seen on filtered events property_typestring The data type of the property typestring Property type: event, person, or group volume_30_daynumber Number of times property was seen in the last 30 days query_usage_30_daynumber Number of times this property was queried in the last 30 days created_atstring ISO timestamp when the property was created updated_atstring ISO timestamp when the property was updated
Property Definition ID*
Property Definition ID
Get Property Definition (posthog_get_property_definition)
Get details of a specific property definition in PostHog. Returns comprehensive information about the property including metadata, type, usage statistics, and verification status.
Input
Parameter Type Required Description projectIdstring Yes PostHog Project ID propertyDefinitionIdstring Yes Property Definition ID to retrieve regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key
Output
Parameter Type Description idstring Unique identifier for the property definition namestring Property name descriptionstring Property description tagsarray Tags associated with the property is_numericalboolean Whether the property is numerical is_seen_on_filtered_eventsboolean Whether the property is seen on filtered events property_typestring The data type of the property typestring Property type: event, person, or group volume_30_daynumber Number of times property was seen in the last 30 days query_usage_30_daynumber Number of times this property was queried in the last 30 days created_atstring ISO timestamp when the property was created updated_atstring ISO timestamp when the property was updated updated_byobject User who last updated the property verifiedboolean Whether the property has been verified verified_atstring ISO timestamp when the property was verified verified_bystring User who verified the property
Operation
Update Property Definition Property Definition ID*
Property Definition ID
Description
Enter description
Tags (comma-separated)
tag1, tag2, tag3
Update Property Definition (posthog_update_property_definition)
Update a property definition in PostHog. Can modify description, tags, property type, and verification status to maintain clean property schemas.
Input
Parameter Type Required Description projectIdstring Yes PostHog Project ID propertyDefinitionIdstring Yes Property Definition ID to update regionstring Yes PostHog cloud region: us or eu apiKeystring Yes PostHog Personal API Key descriptionstring No Updated description for the property tagsstring No Comma-separated list of tags to associate with the property verifiedboolean No Whether to mark the property as verified property_typestring No The data type of the property (e.g., String, Numeric, Boolean, DateTime, etc.)
Output
Parameter Type Description idstring Unique identifier for the property definition namestring Property name descriptionstring Updated property description tagsarray Updated tags associated with the property is_numericalboolean Whether the property is numerical is_seen_on_filtered_eventsboolean Whether the property is seen on filtered events property_typestring The data type of the property typestring Property type: event, person, or group volume_30_daynumber Number of times property was seen in the last 30 days query_usage_30_daynumber Number of times this property was queried in the last 30 days created_atstring ISO timestamp when the property was created updated_atstring ISO timestamp when the property was updated updated_byobject User who last updated the property verifiedboolean Whether the property has been verified verified_atstring ISO timestamp when the property was verified verified_bystring User who verified the property
Project ID*
Enter your PostHog project ID
List Projects (posthog_list_projects)
List all projects in the organization. Returns project details including IDs, names, API tokens, and settings. Useful for getting project IDs needed by other endpoints.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key regionstring No Cloud region: us or eu (default: us)
Output
Parameter Type Description idnumber Project ID uuidstring Project UUID organizationstring Organization UUID api_tokenstring Project API token for ingestion app_urlsarray Allowed app URLs namestring Project name slack_incoming_webhookstring Slack webhook URL for notifications created_atstring Project creation timestamp updated_atstring Last update timestamp anonymize_ipsboolean Whether IP anonymization is enabled completed_snippet_onboardingboolean Whether snippet onboarding is completed ingested_eventboolean Whether any event has been ingested test_account_filtersarray Filters for test accounts is_demoboolean Whether this is a demo project timezonestring Project timezone
Project ID*
Enter your PostHog project ID
Get Project (posthog_get_project)
Get detailed information about a specific project by ID. Returns comprehensive project configuration, settings, and feature flags.
Input
Parameter Type Required Description projectIdstring Yes Project ID (numeric ID or UUID) apiKeystring Yes PostHog Personal API Key regionstring No Cloud region: us or eu (default: us)
Output
Parameter Type Description idnumber Project ID uuidstring Project UUID organizationstring Organization UUID api_tokenstring Project API token for ingestion app_urlsarray Allowed app URLs namestring Project name slack_incoming_webhookstring Slack webhook URL for notifications created_atstring Project creation timestamp updated_atstring Last update timestamp anonymize_ipsboolean Whether IP anonymization is enabled completed_snippet_onboardingboolean Whether snippet onboarding is completed ingested_eventboolean Whether any event has been ingested test_account_filtersarray Filters for test accounts is_demoboolean Whether this is a demo project timezonestring Project timezone data_attributesarray Custom data attributes person_display_name_propertiesarray Properties used for person display names correlation_configobject Configuration for correlation analysis autocapture_opt_outboolean Whether autocapture is disabled autocapture_exceptions_opt_inboolean Whether exception autocapture is enabled session_recording_opt_inboolean Whether session recording is enabled capture_console_log_opt_inboolean Whether console log capture is enabled
Project ID*
Enter your PostHog project ID
List Organizations (posthog_list_organizations)
List all organizations the user has access to. Returns organization details including name, slug, membership level, and available product features.
Input
Parameter Type Required Description apiKeystring Yes PostHog Personal API Key regionstring No Cloud region: us or eu (default: us)
Output
Parameter Type Description idstring Organization ID (UUID) namestring Organization name slugstring Organization slug created_atstring Organization creation timestamp updated_atstring Last update timestamp membership_levelnumber User membership level in organization plugins_access_levelnumber Access level for plugins/apps teamsarray List of team IDs in this organization
Project ID*
Enter your PostHog project ID
Organization ID*
Organization ID
Get Organization (posthog_get_organization)
Get detailed information about a specific organization by ID. Returns comprehensive organization settings, features, usage, and team information.
Input
Parameter Type Required Description organizationIdstring Yes Organization ID (UUID) apiKeystring Yes PostHog Personal API Key regionstring No Cloud region: us or eu (default: us)
Output
Parameter Type Description idstring Organization ID (UUID) namestring Organization name slugstring Organization slug created_atstring Organization creation timestamp updated_atstring Last update timestamp membership_levelnumber User membership level in organization plugins_access_levelnumber Access level for plugins/apps teamsarray List of team IDs in this organization available_product_featuresarray Available product features with their limits and descriptions domain_whitelistarray Whitelisted domains for organization is_member_join_email_enabledboolean Whether member join emails are enabled metadataobject Organization metadata customer_idstring Customer ID for billing available_featuresarray List of available feature flags for organization
Integrate PostHog into your workflow. Track events, manage feature flags, analyze user behavior, run experiments, create surveys, and access session recordings.
Category: tools
Type: posthog