Sim

PostHog

Product analytics and feature management

The PostHog tool integrates powerful product analytics, feature flag management, experimentation, and user behavior insights directly into your agentic workflows. Designed for modern teams, it enables you to capture, analyze, and act on user data in real time — helping you build better products, understand engagement, and boost conversions.

With the PostHog tool, you can:

  • Track and analyze events: Use the posthog_capture_event and posthog_batch_events operations to record individual or multiple user actions, page views, or custom events for deep analytics.
  • Explore event data: Retrieve and list historical or real-time events using the posthog_list_events operation for advanced event analysis.
  • Understand users: Leverage the posthog_list_persons, posthog_get_person, and posthog_delete_person operations to manage user profiles, get detailed user insights, or remove them as needed.
  • Gain actionable product insights: Visualize user journeys, feature usage, and engagement via posthog_list_insights, posthog_get_insight, and posthog_create_insight operations.
  • Manage and roll out features safely: Toggle features and run A/B or multivariate tests at scale using operations like posthog_list_feature_flags, posthog_get_feature_flag, posthog_create_feature_flag, posthog_update_feature_flag, and posthog_delete_feature_flag.
  • Segment and target audiences: Build, list, or manage cohorts with posthog_list_cohorts, posthog_get_cohort, and posthog_create_cohort.
  • Gather direct feedback: Design, deploy, and analyze surveys through posthog_list_surveys, posthog_get_survey, posthog_create_survey, and posthog_update_survey.
  • Monitor user experience: Access and analyze session recordings via the posthog_list_session_recordings and posthog_get_session_recording operations.
  • Collaborate with your team: Organize dashboards (posthog_list_dashboards, posthog_get_dashboard), create and annotate insights and events, and manage projects and organizations within PostHog.

Whether you want to implement full-scale product analytics, enhance user onboarding, refine your product roadmap, or automate decisions based on real usage data, the PostHog tool empowers your agents and workflows with advanced analytics and in-product experimentation — all in one unified platform.

Looking for true product analytics with privacy, scalability, and an open-source option? PostHog is trusted by fast-moving teams and enterprises worldwide.

Usage Instructions

Integrate PostHog into your workflow. Track events, manage feature flags, analyze user behavior, run experiments, create surveys, and access session recordings.

Tools

posthog_capture_event

Capture a single event in PostHog. Use this to track user actions, page views, or custom events.

Input

ParameterTypeRequiredDescription
projectApiKeystringYesPostHog Project API Key (public token for event ingestion)
regionstringNoPostHog region: us (default) or eu
eventstringYesThe name of the event to capture (e.g., "page_view", "button_clicked")
distinctIdstringYesUnique identifier for the user or device. Can be user ID, device ID, or anonymous ID
propertiesstringNoJSON string of event properties (e.g., {"button_name": "signup", "page": "homepage"})
timestampstringNoISO 8601 timestamp for when the event occurred. If not provided, uses current time

Output

ParameterTypeDescription
statusstringStatus message indicating whether the event was captured successfully

posthog_batch_events

Capture multiple events at once in PostHog. Use this for bulk event ingestion to improve performance.

Input

ParameterTypeRequiredDescription
projectApiKeystringYesPostHog Project API Key (public token for event ingestion)
regionstringNoPostHog region: us (default) or eu
batchstringYesJSON 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

ParameterTypeDescription
statusstringStatus message indicating whether the batch was captured successfully
events_processednumberNumber of events processed in the batch

posthog_list_persons

List persons (users) in PostHog. Returns user profiles with their properties and distinct IDs.

Input

ParameterTypeRequiredDescription
personalApiKeystringYesPostHog Personal API Key (for authenticated API access)
regionstringNoPostHog region: us (default) or eu
projectIdstringYesPostHog Project ID
limitnumberNoNumber of persons to return (default: 100, max: 100)
offsetnumberNoNumber of persons to skip for pagination
searchstringNoSearch persons by email, name, or distinct ID
distinctIdstringNoFilter by specific distinct_id

Output

ParameterTypeDescription
personsarrayList of persons with their properties and identifiers
idstringPerson ID
namestringPerson name
distinct_idsarrayAll distinct IDs associated with this person
created_atstringWhen the person was first seen
uuidstringPerson UUID
nextstringURL for the next page of results (if available)

posthog_get_person

Get detailed information about a specific person in PostHog by their ID or UUID.

Input

ParameterTypeRequiredDescription
personalApiKeystringYesPostHog Personal API Key (for authenticated API access)
regionstringNoPostHog region: us (default) or eu
projectIdstringYesPostHog Project ID
personIdstringYesPerson ID or UUID to retrieve

Output

ParameterTypeDescription
personobjectPerson details including properties and identifiers
idstringPerson ID
namestringPerson name
distinct_idsarrayAll distinct IDs associated with this person
created_atstringWhen the person was first seen
uuidstringPerson UUID

posthog_delete_person

Delete a person from PostHog. This will remove all associated events and data. Use with caution.

Input

ParameterTypeRequiredDescription
personalApiKeystringYesPostHog Personal API Key (for authenticated API access)
regionstringNoPostHog region: us (default) or eu
projectIdstringYesPostHog Project ID
personIdstringYesPerson ID or UUID to delete

Output

ParameterTypeDescription
statusstringStatus message indicating whether the person was deleted successfully

posthog_query

Execute a HogQL query in PostHog. HogQL is PostHog

Input

ParameterTypeRequiredDescription
personalApiKeystringYesPostHog Personal API Key (for authenticated API access)
regionstringNoPostHog region: us (default) or eu
projectIdstringYesPostHog Project ID
querystringYesHogQL query to execute. Example: {"kind": "HogQLQuery", "query": "SELECT event, count() FROM events WHERE timestamp > now() - INTERVAL 1 DAY GROUP BY event"}
ExamplestringNoNo description
valuesstringNoOptional JSON string of parameter values for parameterized queries. Example: {"user_id": "123"}
ExamplestringNoNo description

Output

ParameterTypeDescription
resultsarrayQuery results as an array of rows
columnsarrayColumn names in the result set
typesarrayData types of columns in the result set
hogqlstringThe actual HogQL query that was executed
has_morebooleanWhether there are more results available

posthog_list_insights

List all insights in a PostHog project. Returns insight configurations, filters, and metadata.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
limitnumberNoNumber of results to return per page (default: 100)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
countnumberTotal number of insights in the project
nextstringURL for the next page of results
previousstringURL for the previous page of results
resultsarrayList of insights with their configurations and metadata
idnumberUnique identifier for the insight
namestringName of the insight
descriptionstringDescription of the insight
filtersobjectFilter configuration for the insight
queryobjectQuery configuration for the insight
created_atstringISO timestamp when insight was created
created_byobjectUser who created the insight
last_modified_atstringISO timestamp when insight was last modified
last_modified_byobjectUser who last modified the insight
savedbooleanWhether the insight is saved
dashboardsarrayIDs of dashboards this insight appears on

posthog_get_insight

Get a specific insight by ID from PostHog. Returns detailed insight configuration, filters, and metadata.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
insightIdstringYesThe insight ID to retrieve
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")

Output

ParameterTypeDescription
idnumberUnique identifier for the insight
namestringName of the insight
descriptionstringDescription of the insight
filtersobjectFilter configuration for the insight
queryobjectQuery configuration for the insight
created_atstringISO timestamp when insight was created
created_byobjectUser who created the insight
last_modified_atstringISO timestamp when insight was last modified
last_modified_byobjectUser who last modified the insight
savedbooleanWhether the insight is saved
dashboardsarrayIDs of dashboards this insight appears on
tagsarrayTags associated with the insight
favoritedbooleanWhether the insight is favorited

posthog_create_insight

Create a new insight in PostHog. Requires insight name and configuration filters or query.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
namestringNoName for the insight (optional - PostHog will generate a derived name if not provided)
descriptionstringNoDescription of the insight
filtersstringNoJSON string of filter configuration for the insight
querystringNoJSON string of query configuration for the insight
dashboardsstringNoComma-separated list of dashboard IDs to add this insight to
tagsstringNoComma-separated list of tags for the insight

Output

ParameterTypeDescription
idnumberUnique identifier for the created insight
namestringName of the insight
descriptionstringDescription of the insight
filtersobjectFilter configuration for the insight
queryobjectQuery configuration for the insight
created_atstringISO timestamp when insight was created
created_byobjectUser who created the insight
last_modified_atstringISO timestamp when insight was last modified
savedbooleanWhether the insight is saved
dashboardsarrayIDs of dashboards this insight appears on
tagsarrayTags associated with the insight

posthog_list_dashboards

List all dashboards in a PostHog project. Returns dashboard configurations, tiles, and metadata.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
limitnumberNoNumber of results to return per page (default: 100)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
countnumberTotal number of dashboards in the project
nextstringURL for the next page of results
previousstringURL for the previous page of results
resultsarrayList of dashboards with their configurations and metadata
idnumberUnique identifier for the dashboard
namestringName of the dashboard
descriptionstringDescription of the dashboard
pinnedbooleanWhether the dashboard is pinned
created_atstringISO timestamp when dashboard was created
created_byobjectUser who created the dashboard
last_modified_atstringISO timestamp when dashboard was last modified
last_modified_byobjectUser who last modified the dashboard
tilesarrayTiles/widgets on the dashboard
filtersobjectGlobal filters for the dashboard
tagsarrayTags associated with the dashboard

posthog_get_dashboard

Get a specific dashboard by ID from PostHog. Returns detailed dashboard configuration, tiles, and metadata.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
dashboardIdstringYesThe dashboard ID to retrieve
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")

Output

ParameterTypeDescription
idnumberUnique identifier for the dashboard
namestringName of the dashboard
descriptionstringDescription of the dashboard
pinnedbooleanWhether the dashboard is pinned
created_atstringISO timestamp when dashboard was created
created_byobjectUser who created the dashboard
last_modified_atstringISO timestamp when dashboard was last modified
last_modified_byobjectUser who last modified the dashboard
tilesarrayTiles/widgets on the dashboard with their configurations
filtersobjectGlobal filters applied to the dashboard
tagsarrayTags associated with the dashboard
restriction_levelnumberAccess restriction level for the dashboard

posthog_list_actions

List all actions in a PostHog project. Returns action definitions, steps, and metadata.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
limitnumberNoNumber of results to return per page (default: 100)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
countnumberTotal number of actions in the project
nextstringURL for the next page of results
previousstringURL for the previous page of results
resultsarrayList of actions with their definitions and metadata
idnumberUnique identifier for the action
namestringName of the action
descriptionstringDescription of the action
tagsarrayTags associated with the action
post_to_slackbooleanWhether to post this action to Slack
slack_message_formatstringFormat string for Slack messages
stepsarraySteps that define the action
created_atstringISO timestamp when action was created
created_byobjectUser who created the action
deletedbooleanWhether the action is deleted
is_calculatingbooleanWhether the action is being calculated
last_calculated_atstringISO timestamp of last calculation

posthog_list_cohorts

List all cohorts in a PostHog project. Returns cohort definitions, filters, and user counts.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
limitnumberNoNumber of results to return per page (default: 100)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
countnumberTotal number of cohorts in the project
nextstringURL for the next page of results
previousstringURL for the previous page of results
resultsarrayList of cohorts with their definitions and metadata
idnumberUnique identifier for the cohort
namestringName of the cohort
descriptionstringDescription of the cohort
groupsarrayGroups that define the cohort
deletedbooleanWhether the cohort is deleted
filtersobjectFilter configuration for the cohort
queryobjectQuery configuration for the cohort
created_atstringISO timestamp when cohort was created
created_byobjectUser who created the cohort
is_calculatingbooleanWhether the cohort is being calculated
last_calculationstringISO timestamp of last calculation
errors_calculatingnumberNumber of errors during calculation
countnumberNumber of users in the cohort
is_staticbooleanWhether the cohort is static

posthog_get_cohort

Get a specific cohort by ID from PostHog. Returns detailed cohort definition, filters, and user count.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
cohortIdstringYesThe cohort ID to retrieve
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")

Output

ParameterTypeDescription
idnumberUnique identifier for the cohort
namestringName of the cohort
descriptionstringDescription of the cohort
groupsarrayGroups that define the cohort
deletedbooleanWhether the cohort is deleted
filtersobjectFilter configuration for the cohort
queryobjectQuery configuration for the cohort
created_atstringISO timestamp when cohort was created
created_byobjectUser who created the cohort
is_calculatingbooleanWhether the cohort is being calculated
last_calculationstringISO timestamp of last calculation
errors_calculatingnumberNumber of errors during calculation
countnumberNumber of users in the cohort
is_staticbooleanWhether the cohort is static
versionnumberVersion number of the cohort

posthog_create_cohort

Create a new cohort in PostHog. Requires cohort name and filter or query configuration.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
namestringNoName for the cohort (optional - PostHog will use "Untitled cohort" if not provided)
descriptionstringNoDescription of the cohort
filtersstringNoJSON string of filter configuration for the cohort
querystringNoJSON string of query configuration for the cohort
is_staticbooleanNoWhether the cohort is static (default: false)
groupsstringNoJSON string of groups that define the cohort

Output

ParameterTypeDescription
idnumberUnique identifier for the created cohort
namestringName of the cohort
descriptionstringDescription of the cohort
groupsarrayGroups that define the cohort
deletedbooleanWhether the cohort is deleted
filtersobjectFilter configuration for the cohort
queryobjectQuery configuration for the cohort
created_atstringISO timestamp when cohort was created
created_byobjectUser who created the cohort
is_calculatingbooleanWhether the cohort is being calculated
countnumberNumber of users in the cohort
is_staticbooleanWhether the cohort is static
versionnumberVersion number of the cohort

posthog_list_annotations

List all annotations in a PostHog project. Returns annotation content, timestamps, and associated insights.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
limitnumberNoNumber of results to return per page (default: 100)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
countnumberTotal number of annotations in the project
nextstringURL for the next page of results
previousstringURL for the previous page of results
resultsarrayList of annotations with their content and metadata
idnumberUnique identifier for the annotation
contentstringContent/text of the annotation
date_markerstringISO timestamp marking when the annotation applies
created_atstringISO timestamp when annotation was created
updated_atstringISO timestamp when annotation was last updated
created_byobjectUser who created the annotation
dashboard_itemnumberID of dashboard item this annotation is attached to
insight_short_idstringShort ID of the insight this annotation is attached to
insight_namestringName of the insight this annotation is attached to
scopestringScope of the annotation (project or dashboard)
deletedbooleanWhether the annotation is deleted

posthog_create_annotation

Create a new annotation in PostHog. Mark important events on your graphs with date and description.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesThe PostHog project ID
regionstringNoPostHog cloud region: "us" or "eu" (default: "us")
contentstringYesContent/text of the annotation
date_markerstringYesISO timestamp marking when the annotation applies (e.g., "2024-01-15T10:00:00Z")
scopestringNoScope of the annotation: "project" or "dashboard_item" (default: "project")
dashboard_itemstringNoID of dashboard item to attach this annotation to
insight_short_idstringNoShort ID of the insight to attach this annotation to

Output

ParameterTypeDescription
idnumberUnique identifier for the created annotation
contentstringContent/text of the annotation
date_markerstringISO timestamp marking when the annotation applies
created_atstringISO timestamp when annotation was created
updated_atstringISO timestamp when annotation was last updated
created_byobjectUser who created the annotation
dashboard_itemnumberID of dashboard item this annotation is attached to
insight_short_idstringShort ID of the insight this annotation is attached to
insight_namestringName of the insight this annotation is attached to
scopestringScope of the annotation (project or dashboard_item)
deletedbooleanWhether the annotation is deleted

posthog_list_feature_flags

List all feature flags in a PostHog project

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
limitnumberNoNumber of results to return
offsetnumberNoNumber of results to skip

Output

ParameterTypeDescription
resultsarrayList of feature flags
idnumberFeature flag ID
namestringFeature flag name
keystringFeature flag key
filtersobjectFeature flag filters
deletedbooleanWhether the flag is deleted
activebooleanWhether the flag is active
created_atstringCreation timestamp
created_byobjectCreator information
is_simple_flagbooleanWhether this is a simple flag
rollout_percentagenumberRollout percentage (if applicable)
ensure_experience_continuitybooleanWhether to ensure experience continuity
countnumberTotal number of feature flags
nextstringURL to next page of results
previousstringURL to previous page of results

posthog_get_feature_flag

Get details of a specific feature flag

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
flagIdstringYesThe feature flag ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key

Output

ParameterTypeDescription
flagobjectFeature flag details
idnumberFeature flag ID
namestringFeature flag name
keystringFeature flag key
filtersobjectFeature flag filters
deletedbooleanWhether the flag is deleted
activebooleanWhether the flag is active
created_atstringCreation timestamp
created_byobjectCreator information
is_simple_flagbooleanWhether this is a simple flag
rollout_percentagenumberRollout percentage (if applicable)
ensure_experience_continuitybooleanWhether to ensure experience continuity
usage_dashboardnumberUsage dashboard ID
has_enriched_analyticsbooleanWhether enriched analytics are enabled

posthog_create_feature_flag

Create a new feature flag in PostHog

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
namestringNoFeature flag name (optional - can be empty)
keystringYesFeature flag key (unique identifier)
filtersstringNoFeature flag filters as JSON string
activebooleanNoWhether the flag is active (default: true)
ensureExperienceContinuitybooleanNoWhether to ensure experience continuity (default: false)
rolloutPercentagenumberNoRollout percentage (0-100)

Output

ParameterTypeDescription
flagobjectCreated feature flag
idnumberFeature flag ID
namestringFeature flag name
keystringFeature flag key
filtersobjectFeature flag filters
deletedbooleanWhether the flag is deleted
activebooleanWhether the flag is active
created_atstringCreation timestamp
created_byobjectCreator information
is_simple_flagbooleanWhether this is a simple flag
rollout_percentagenumberRollout percentage (if applicable)
ensure_experience_continuitybooleanWhether to ensure experience continuity

posthog_update_feature_flag

Update an existing feature flag in PostHog

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
flagIdstringYesThe feature flag ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
namestringNoFeature flag name
keystringNoFeature flag key (unique identifier)
filtersstringNoFeature flag filters as JSON string
activebooleanNoWhether the flag is active
ensureExperienceContinuitybooleanNoWhether to ensure experience continuity
rolloutPercentagenumberNoRollout percentage (0-100)

Output

ParameterTypeDescription
flagobjectUpdated feature flag
idnumberFeature flag ID
namestringFeature flag name
keystringFeature flag key
filtersobjectFeature flag filters
deletedbooleanWhether the flag is deleted
activebooleanWhether the flag is active
created_atstringCreation timestamp
created_byobjectCreator information
is_simple_flagbooleanWhether this is a simple flag
rollout_percentagenumberRollout percentage (if applicable)
ensure_experience_continuitybooleanWhether to ensure experience continuity

posthog_delete_feature_flag

Delete a feature flag from PostHog

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
flagIdstringYesThe feature flag ID to delete
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key

Output

ParameterTypeDescription
successbooleanWhether the deletion was successful
messagestringConfirmation message

posthog_evaluate_flags

Evaluate feature flags for a specific user or group. This is a public endpoint that uses the project API key.

Input

ParameterTypeRequiredDescription
regionstringYesPostHog cloud region: us or eu
projectApiKeystringYesPostHog Project API Key (not personal API key)
distinctIdstringYesThe distinct ID of the user to evaluate flags for
groupsstringNoGroups as JSON string (e.g., {"company": "company_id_in_your_db"})
personPropertiesstringNoPerson properties as JSON string
groupPropertiesstringNoGroup properties as JSON string

Output

ParameterTypeDescription
feature_flagsobjectFeature flag evaluations (key-value pairs where values are boolean or string variants)
feature_flag_payloadsobjectAdditional payloads attached to feature flags
errors_while_computing_flagsbooleanWhether there were errors while computing flags

posthog_list_experiments

List all experiments in a PostHog project

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
limitnumberNoNumber of results to return
offsetnumberNoNumber of results to skip

Output

ParameterTypeDescription
resultsarrayList of experiments
idnumberExperiment ID
namestringExperiment name
descriptionstringExperiment description
feature_flag_keystringAssociated feature flag key
feature_flagobjectFeature flag details
parametersobjectExperiment parameters
filtersobjectExperiment filters
variantsobjectExperiment variants
start_datestringStart date
end_datestringEnd date
created_atstringCreation timestamp
created_byobjectCreator information
archivedbooleanWhether the experiment is archived
countnumberTotal number of experiments
nextstringURL to next page of results
previousstringURL to previous page of results

posthog_get_experiment

Get details of a specific experiment

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
experimentIdstringYesThe experiment ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key

Output

ParameterTypeDescription
experimentobjectExperiment details
idnumberExperiment ID
namestringExperiment name
descriptionstringExperiment description
feature_flag_keystringAssociated feature flag key
feature_flagobjectFeature flag details
parametersobjectExperiment parameters
filtersobjectExperiment filters
variantsobjectExperiment variants
start_datestringStart date
end_datestringEnd date
created_atstringCreation timestamp
created_byobjectCreator information
archivedbooleanWhether the experiment is archived
metricsarrayPrimary metrics
metrics_secondaryarraySecondary metrics

posthog_create_experiment

Create a new experiment in PostHog

Input

ParameterTypeRequiredDescription
projectIdstringYesThe PostHog project ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
namestringNoExperiment name (optional)
descriptionstringNoExperiment description
featureFlagKeystringYesFeature flag key to use for the experiment
parametersstringNoExperiment parameters as JSON string
filtersstringNoExperiment filters as JSON string
variantsstringNoExperiment variants as JSON string
startDatestringNoExperiment start date (ISO format)
endDatestringNoExperiment end date (ISO format)

Output

ParameterTypeDescription
experimentobjectCreated experiment
idnumberExperiment ID
namestringExperiment name
descriptionstringExperiment description
feature_flag_keystringAssociated feature flag key
feature_flagobjectFeature flag details
parametersobjectExperiment parameters
filtersobjectExperiment filters
variantsobjectExperiment variants
start_datestringStart date
end_datestringEnd date
created_atstringCreation timestamp
created_byobjectCreator information
archivedbooleanWhether the experiment is archived

posthog_list_surveys

List all surveys in a PostHog project. Surveys allow you to collect feedback from users.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesPostHog Project ID
regionstringNoPostHog cloud region: us or eu (default: us)
limitnumberNoNumber of results to return (default: 100)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
surveysarrayList of surveys in the project
idstringSurvey ID
namestringSurvey name
descriptionstringSurvey description
typestringSurvey type (popover or api)
questionsarraySurvey questions
created_atstringCreation timestamp
start_datestringSurvey start date
end_datestringSurvey end date
archivedbooleanWhether survey is archived
countnumberTotal number of surveys
nextstringURL for next page of results
previousstringURL for previous page of results

posthog_get_survey

Get details of a specific survey in PostHog by ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesPostHog Project ID
surveyIdstringYesSurvey ID to retrieve
regionstringNoPostHog cloud region: us or eu (default: us)

Output

ParameterTypeDescription
surveyobjectSurvey details
idstringSurvey ID
namestringSurvey name
descriptionstringSurvey description
typestringSurvey type (popover or api)
questionsarraySurvey questions
appearanceobjectSurvey appearance configuration
conditionsobjectSurvey display conditions
created_atstringCreation timestamp
created_byobjectCreator information
start_datestringSurvey start date
end_datestringSurvey end date
archivedbooleanWhether survey is archived
responses_limitnumberMaximum number of responses

posthog_create_survey

Create a new survey in PostHog. Supports question types: Basic (open), Link, Rating, and Multiple Choice.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesPostHog Project ID
regionstringNoPostHog cloud region: us or eu (default: us)
namestringNoSurvey name (optional)
descriptionstringNoSurvey description
typestringNoSurvey type: popover (in-app) or api (custom implementation) (default: popover)
questionsstringYesJSON 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.
startDatestringNoSurvey start date in ISO 8601 format
endDatestringNoSurvey end date in ISO 8601 format
appearancestringNoJSON string of appearance configuration (colors, position, etc.)
conditionsstringNoJSON string of display conditions (URL matching, etc.)
targetingFlagFiltersstringNoJSON string of feature flag filters for targeting
linkedFlagIdstringNoFeature flag ID to link to this survey
responsesLimitnumberNoMaximum number of responses to collect

Output

ParameterTypeDescription
surveyobjectCreated survey details
idstringSurvey ID
namestringSurvey name
descriptionstringSurvey description
typestringSurvey type (popover or api)
questionsarraySurvey questions
created_atstringCreation timestamp
start_datestringSurvey start date
end_datestringSurvey end date

posthog_update_survey

Update an existing survey in PostHog. Can modify questions, appearance, conditions, and other settings.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesPostHog Project ID
surveyIdstringYesSurvey ID to update
regionstringNoPostHog cloud region: us or eu (default: us)
namestringNoSurvey name
descriptionstringNoSurvey description
typestringNoSurvey type: popover or api
questionsstringNoJSON string of survey questions array. Each question must have type (open/link/rating/multiple_choice) and question text.
startDatestringNoSurvey start date in ISO 8601 format
endDatestringNoSurvey end date in ISO 8601 format
appearancestringNoJSON string of appearance configuration (colors, position, etc.)
conditionsstringNoJSON string of display conditions (URL matching, etc.)
targetingFlagFiltersstringNoJSON string of feature flag filters for targeting
linkedFlagIdstringNoFeature flag ID to link to this survey
responsesLimitnumberNoMaximum number of responses to collect
archivedbooleanNoArchive or unarchive the survey

Output

ParameterTypeDescription
surveyobjectUpdated survey details
idstringSurvey ID
namestringSurvey name
descriptionstringSurvey description
typestringSurvey type (popover or api)
questionsarraySurvey questions
created_atstringCreation timestamp
start_datestringSurvey start date
end_datestringSurvey end date
archivedbooleanWhether survey is archived

posthog_list_session_recordings

List session recordings in a PostHog project. Session recordings capture user interactions with your application.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesPostHog Project ID
regionstringNoPostHog cloud region: us or eu (default: us)
limitnumberNoNumber of results to return (default: 50)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
recordingsarrayList of session recordings
idstringRecording ID
distinct_idstringUser distinct ID
viewedbooleanWhether recording has been viewed
recording_durationnumberRecording duration in seconds
active_secondsnumberActive time in seconds
inactive_secondsnumberInactive time in seconds
start_timestringRecording start timestamp
end_timestringRecording end timestamp
click_countnumberNumber of clicks
keypress_countnumberNumber of keypresses
console_log_countnumberNumber of console logs
console_warn_countnumberNumber of console warnings
console_error_countnumberNumber of console errors
personobjectPerson information
countnumberTotal number of recordings
nextstringURL for next page of results
previousstringURL for previous page of results

posthog_get_session_recording

Get details of a specific session recording in PostHog by ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesPostHog Project ID
recordingIdstringYesSession recording ID to retrieve
regionstringNoPostHog cloud region: us or eu (default: us)

Output

ParameterTypeDescription
recordingobjectSession recording details
idstringRecording ID
distinct_idstringUser distinct ID
viewedbooleanWhether recording has been viewed
recording_durationnumberRecording duration in seconds
active_secondsnumberActive time in seconds
inactive_secondsnumberInactive time in seconds
start_timestringRecording start timestamp
end_timestringRecording end timestamp
click_countnumberNumber of clicks
keypress_countnumberNumber of keypresses
console_log_countnumberNumber of console logs
console_warn_countnumberNumber of console warnings
console_error_countnumberNumber of console errors
start_urlstringStarting URL of the recording
personobjectPerson information
matching_eventsarrayEvents that occurred during recording

posthog_list_recording_playlists

List session recording playlists in a PostHog project. Playlists allow you to organize and curate session recordings.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
projectIdstringYesPostHog Project ID
regionstringNoPostHog cloud region: us or eu (default: us)
limitnumberNoNumber of results to return (default: 100)
offsetnumberNoNumber of results to skip for pagination

Output

ParameterTypeDescription
playlistsarrayList of session recording playlists
idstringPlaylist ID
short_idstringPlaylist short ID
namestringPlaylist name
descriptionstringPlaylist description
created_atstringCreation timestamp
created_byobjectCreator information
deletedbooleanWhether playlist is deleted
filtersobjectPlaylist filters
last_modified_atstringLast modification timestamp
last_modified_byobjectLast modifier information
derived_namestringAuto-generated name from filters
countnumberTotal number of playlists
nextstringURL for next page of results
previousstringURL for previous page of results

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

ParameterTypeRequiredDescription
projectIdstringYesPostHog Project ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
limitnumberNoNumber of results to return per page (default: 100)
offsetnumberNoThe initial index from which to return results
searchstringNoSearch term to filter event definitions by name

Output

ParameterTypeDescription
countnumberTotal number of event definitions
nextstringURL for the next page of results
previousstringURL for the previous page of results
resultsarrayList of event definitions
idstringUnique identifier for the event definition
namestringEvent name
descriptionstringEvent description
tagsarrayTags associated with the event
volume_30_daynumberNumber of events received in the last 30 days
query_usage_30_daynumberNumber of times this event was queried in the last 30 days
created_atstringISO timestamp when the event was created
last_seen_atstringISO timestamp when the event was last seen
updated_atstringISO timestamp when the event was updated
updated_byobjectUser who last updated the event

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

ParameterTypeRequiredDescription
projectIdstringYesPostHog Project ID
eventDefinitionIdstringYesEvent Definition ID to retrieve
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key

Output

ParameterTypeDescription
idstringUnique identifier for the event definition
namestringEvent name
descriptionstringEvent description
tagsarrayTags associated with the event
volume_30_daynumberNumber of events received in the last 30 days
query_usage_30_daynumberNumber of times this event was queried in the last 30 days
created_atstringISO timestamp when the event was created
last_seen_atstringISO timestamp when the event was last seen
updated_atstringISO timestamp when the event was updated
updated_byobjectUser who last updated the event
verifiedbooleanWhether the event has been verified
verified_atstringISO timestamp when the event was verified
verified_bystringUser who verified the event

posthog_update_event_definition

Update an event definition in PostHog. Can modify description, tags, and verification status to maintain clean event schemas.

Input

ParameterTypeRequiredDescription
projectIdstringYesPostHog Project ID
eventDefinitionIdstringYesEvent Definition ID to update
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
descriptionstringNoUpdated description for the event
tagsstringNoComma-separated list of tags to associate with the event
verifiedbooleanNoWhether to mark the event as verified

Output

ParameterTypeDescription
idstringUnique identifier for the event definition
namestringEvent name
descriptionstringUpdated event description
tagsarrayUpdated tags associated with the event
volume_30_daynumberNumber of events received in the last 30 days
query_usage_30_daynumberNumber of times this event was queried in the last 30 days
created_atstringISO timestamp when the event was created
last_seen_atstringISO timestamp when the event was last seen
updated_atstringISO timestamp when the event was updated
updated_byobjectUser who last updated the event
verifiedbooleanWhether the event has been verified
verified_atstringISO timestamp when the event was verified
verified_bystringUser who verified the event

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

ParameterTypeRequiredDescription
projectIdstringYesPostHog Project ID
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
limitnumberNoNumber of results to return per page (default: 100)
offsetnumberNoThe initial index from which to return results
searchstringNoSearch term to filter property definitions by name
typestringNoFilter by property type: event, person, or group

Output

ParameterTypeDescription
countnumberTotal number of property definitions
nextstringURL for the next page of results
previousstringURL for the previous page of results
resultsarrayList of property definitions
idstringUnique identifier for the property definition
namestringProperty name
descriptionstringProperty description
tagsarrayTags associated with the property
is_numericalbooleanWhether the property is numerical
is_seen_on_filtered_eventsbooleanWhether the property is seen on filtered events
property_typestringThe data type of the property
typestringProperty type: event, person, or group
volume_30_daynumberNumber of times property was seen in the last 30 days
query_usage_30_daynumberNumber of times this property was queried in the last 30 days
created_atstringISO timestamp when the property was created
updated_atstringISO timestamp when the property was updated
updated_byobjectUser who last updated the property

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

ParameterTypeRequiredDescription
projectIdstringYesPostHog Project ID
propertyDefinitionIdstringYesProperty Definition ID to retrieve
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key

Output

ParameterTypeDescription
idstringUnique identifier for the property definition
namestringProperty name
descriptionstringProperty description
tagsarrayTags associated with the property
is_numericalbooleanWhether the property is numerical
is_seen_on_filtered_eventsbooleanWhether the property is seen on filtered events
property_typestringThe data type of the property
typestringProperty type: event, person, or group
volume_30_daynumberNumber of times property was seen in the last 30 days
query_usage_30_daynumberNumber of times this property was queried in the last 30 days
created_atstringISO timestamp when the property was created
updated_atstringISO timestamp when the property was updated
updated_byobjectUser who last updated the property
verifiedbooleanWhether the property has been verified
verified_atstringISO timestamp when the property was verified
verified_bystringUser who verified the property
examplestringExample value for the property

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

ParameterTypeRequiredDescription
projectIdstringYesPostHog Project ID
propertyDefinitionIdstringYesProperty Definition ID to update
regionstringYesPostHog cloud region: us or eu
apiKeystringYesPostHog Personal API Key
descriptionstringNoUpdated description for the property
tagsstringNoComma-separated list of tags to associate with the property
verifiedbooleanNoWhether to mark the property as verified
property_typestringNoThe data type of the property (e.g., String, Numeric, Boolean, DateTime, etc.)

Output

ParameterTypeDescription
idstringUnique identifier for the property definition
namestringProperty name
descriptionstringUpdated property description
tagsarrayUpdated tags associated with the property
is_numericalbooleanWhether the property is numerical
is_seen_on_filtered_eventsbooleanWhether the property is seen on filtered events
property_typestringThe data type of the property
typestringProperty type: event, person, or group
volume_30_daynumberNumber of times property was seen in the last 30 days
query_usage_30_daynumberNumber of times this property was queried in the last 30 days
created_atstringISO timestamp when the property was created
updated_atstringISO timestamp when the property was updated
updated_byobjectUser who last updated the property
verifiedbooleanWhether the property has been verified
verified_atstringISO timestamp when the property was verified
verified_bystringUser who verified the property
examplestringExample value for the property

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

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)

Output

ParameterTypeDescription
projectsarrayList of projects with their configuration and settings
idnumberProject ID
uuidstringProject UUID
organizationstringOrganization UUID
api_tokenstringProject API token for ingestion
app_urlsarrayAllowed app URLs
namestringProject name
slack_incoming_webhookstringSlack webhook URL for notifications
created_atstringProject creation timestamp
updated_atstringLast update timestamp
anonymize_ipsbooleanWhether IP anonymization is enabled
completed_snippet_onboardingbooleanWhether snippet onboarding is completed
ingested_eventbooleanWhether any event has been ingested
test_account_filtersarrayFilters for test accounts
is_demobooleanWhether this is a demo project
timezonestringProject timezone
data_attributesarrayCustom data attributes

posthog_get_project

Get detailed information about a specific project by ID. Returns comprehensive project configuration, settings, and feature flags.

Input

ParameterTypeRequiredDescription
projectIdstringYesProject ID (numeric ID or UUID)
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)

Output

ParameterTypeDescription
projectobjectDetailed project information with all configuration settings
idnumberProject ID
uuidstringProject UUID
organizationstringOrganization UUID
api_tokenstringProject API token for ingestion
app_urlsarrayAllowed app URLs
namestringProject name
slack_incoming_webhookstringSlack webhook URL for notifications
created_atstringProject creation timestamp
updated_atstringLast update timestamp
anonymize_ipsbooleanWhether IP anonymization is enabled
completed_snippet_onboardingbooleanWhether snippet onboarding is completed
ingested_eventbooleanWhether any event has been ingested
test_account_filtersarrayFilters for test accounts
is_demobooleanWhether this is a demo project
timezonestringProject timezone
data_attributesarrayCustom data attributes
person_display_name_propertiesarrayProperties used for person display names
correlation_configobjectConfiguration for correlation analysis
autocapture_opt_outbooleanWhether autocapture is disabled
autocapture_exceptions_opt_inbooleanWhether exception autocapture is enabled
session_recording_opt_inbooleanWhether session recording is enabled
capture_console_log_opt_inbooleanWhether console log capture is enabled
capture_performance_opt_inbooleanWhether performance capture is enabled

posthog_list_organizations

List all organizations the user has access to. Returns organization details including name, slug, membership level, and available product features.

Input

ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)

Output

ParameterTypeDescription
organizationsarrayList of organizations with their settings and features
idstringOrganization ID (UUID)
namestringOrganization name
slugstringOrganization slug
created_atstringOrganization creation timestamp
updated_atstringLast update timestamp
membership_levelnumberUser membership level in organization
plugins_access_levelnumberAccess level for plugins/apps
teamsarrayList of team IDs in this organization
available_product_featuresarrayAvailable product features and their limits

posthog_get_organization

Get detailed information about a specific organization by ID. Returns comprehensive organization settings, features, usage, and team information.

Input

ParameterTypeRequiredDescription
organizationIdstringYesOrganization ID (UUID)
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)

Output

ParameterTypeDescription
organizationobjectDetailed organization information with settings and features
idstringOrganization ID (UUID)
namestringOrganization name
slugstringOrganization slug
created_atstringOrganization creation timestamp
updated_atstringLast update timestamp
membership_levelnumberUser membership level in organization
plugins_access_levelnumberAccess level for plugins/apps
teamsarrayList of team IDs in this organization
available_product_featuresarrayAvailable product features with their limits and descriptions
domain_whitelistarrayWhitelisted domains for organization
is_member_join_email_enabledbooleanWhether member join emails are enabled
metadataobjectOrganization metadata
customer_idstringCustomer ID for billing
available_featuresarrayList of available feature flags for organization
usageobjectOrganization usage statistics
On this page

On this page

Usage Instructions
Tools
posthog_capture_event
Input
Output
posthog_batch_events
Input
Output
posthog_list_persons
Input
Output
posthog_get_person
Input
Output
posthog_delete_person
Input
Output
posthog_query
Input
Output
posthog_list_insights
Input
Output
posthog_get_insight
Input
Output
posthog_create_insight
Input
Output
posthog_list_dashboards
Input
Output
posthog_get_dashboard
Input
Output
posthog_list_actions
Input
Output
posthog_list_cohorts
Input
Output
posthog_get_cohort
Input
Output
posthog_create_cohort
Input
Output
posthog_list_annotations
Input
Output
posthog_create_annotation
Input
Output
posthog_list_feature_flags
Input
Output
posthog_get_feature_flag
Input
Output
posthog_create_feature_flag
Input
Output
posthog_update_feature_flag
Input
Output
posthog_delete_feature_flag
Input
Output
posthog_evaluate_flags
Input
Output
posthog_list_experiments
Input
Output
posthog_get_experiment
Input
Output
posthog_create_experiment
Input
Output
posthog_list_surveys
Input
Output
posthog_get_survey
Input
Output
posthog_create_survey
Input
Output
posthog_update_survey
Input
Output
posthog_list_session_recordings
Input
Output
posthog_get_session_recording
Input
Output
posthog_list_recording_playlists
Input
Output
posthog_list_event_definitions
Input
Output
posthog_get_event_definition
Input
Output
posthog_update_event_definition
Input
Output
posthog_list_property_definitions
Input
Output
posthog_get_property_definition
Input
Output
posthog_update_property_definition
Input
Output
posthog_list_projects
Input
Output
posthog_get_project
Input
Output
posthog_list_organizations
Input
Output
posthog_get_organization
Input
Output
Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started