PostHog

Product analytics and feature management

Configuration

Capture Event

Operation
Capture Event
Region
Select...
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
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

Refer to the block outputs for this operation.


Batch Events

Operation
Batch Events
Region
Select...
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
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

List Persons

Operation
List Persons
Region
Select...
Distinct ID Filter
user123
Limit
100
Offset
0
Search
Search query
List Persons (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
idstringPerson ID
namestringPerson name
distinct_idsarrayAll distinct IDs associated with this person
propertiesobjectPerson properties
created_atstringWhen the person was first seen

Get Person

Operation
Get Person
Region
Select...
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
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
idstringPerson ID
namestringPerson name
distinct_idsarrayAll distinct IDs associated with this person
propertiesobjectPerson properties
created_atstringWhen the person was first seen

Delete Person

Operation
Delete Person
Region
Select...
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
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

Refer to the block outputs for this operation.


Run Query (HogQL)

Operation
Run Query (HogQL)
Region
Select...
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
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

Refer to the block outputs for this operation.


List Insights

Operation
List Insights
Region
Select...
Limit
100
Offset
0
List Insights (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
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

Get Insight

Operation
Get Insight
Region
Select...
Insight ID*
Insight ID
Get Insight (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

Create Insight

Operation
Create Insight
Region
Select...
Name
Enter name
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
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

List Dashboards

Operation
List Dashboards
Region
Select...
Limit
100
Offset
0
List Dashboards (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
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

Get Dashboard

Operation
Get Dashboard
Region
Select...
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
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

List Actions

Operation
List Actions
Region
Select...
Limit
100
Offset
0
List Actions (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
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

List Cohorts

Operation
List Cohorts
Region
Select...
Limit
100
Offset
0
List Cohorts (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
countnumberNumber of users in the cohort
nextstringURL for the next page of results
previousstringURL for the previous page of results
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

Get Cohort

Operation
Get Cohort
Region
Select...
Cohort ID*
Cohort ID
Get Cohort (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

Create Cohort

Operation
Create Cohort
Region
Select...
Query
HogQL query or JSON object
Name
Enter name
Description
Enter description
Filters (JSON)
{"groups": [...]}
Groups (JSON Array)
[{"properties": [...]}]
Static Cohort
Disabled
Create 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

List Annotations

Operation
List Annotations
Region
Select...
Limit
100
Offset
0
List Annotations (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
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)

Create Annotation

Operation
Create Annotation
Region
Select...
Name
Enter name
Content*
Annotation content
Date Marker (ISO 8601)*
2024-01-01T12:00:00Z
Scope
Select...
Create Annotation (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)

List Feature Flags

Operation
List Feature Flags
Region
Select...
Limit
100
Offset
0
List Feature Flags (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
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)

Get Feature Flag

Operation
Get Feature Flag
Region
Select...
Feature Flag ID*
Feature Flag ID
Get Feature Flag (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
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

Create Feature Flag

Operation
Create Feature Flag
Region
Select...
Name
Enter name
Description
Enter description
Flag Key*
feature_flag_key
Filters (JSON)
{"groups": [...]}
Active
Disabled
Rollout Percentage
100
Ensure Experience Continuity
Disabled
Create Feature Flag (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
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)

Update Feature Flag

Operation
Update Feature Flag
Region
Select...
Feature Flag ID*
Feature Flag ID
Name
Enter name
Description
Enter description
Flag Key
feature_flag_key
Filters (JSON)
{"groups": [...]}
Active
Disabled
Rollout Percentage
100
Ensure Experience Continuity
Disabled
Update Feature Flag (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
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)

Delete Feature Flag

Operation
Delete Feature Flag
Region
Select...
Feature Flag ID*
Feature Flag ID
Delete Feature Flag (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

Evaluate Flags

Operation
Evaluate Flags
Region
Select...
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
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
featureFlagsobjectFeature flag evaluations (key-value pairs where values are boolean or string variants)
featureFlagPayloadsobjectAdditional payloads attached to feature flags

List Experiments

Operation
List Experiments
Region
Select...
Limit
100
Offset
0
List Experiments (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
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

Get Experiment

Operation
Get Experiment
Region
Select...
Experiment ID*
Experiment ID
Get Experiment (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
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

Create Experiment

Operation
Create Experiment
Region
Select...
Name
Enter name
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
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
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

List Surveys

Operation
List Surveys
Region
Select...
Limit
100
Offset
0
List Surveys (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
idstringSurvey ID
namestringSurvey name
descriptionstringSurvey description
typestringSurvey type (popover or api)
questionsarraySurvey questions
created_atstringCreation timestamp
start_datestringSurvey start date
end_datestringSurvey end date

Get Survey

Operation
Get Survey
Region
Select...
Survey ID*
Survey ID
Get Survey (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
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

Create Survey

Operation
Create Survey
Region
Select...
Name
Enter name
Description
Enter description
Questions (JSON Array)*
[{"type": "open", "question": "What do you think?"}]
Survey Type
Select...
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
Responses Limit
1000
Create Survey (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
idstringSurvey ID
namestringSurvey name
descriptionstringSurvey description
typestringSurvey type (popover or api)
questionsarraySurvey questions
created_atstringCreation timestamp
start_datestringSurvey start date

Update Survey

Operation
Update Survey
Region
Select...
Survey ID*
Survey ID
Name
Enter name
Description
Enter description
Questions (JSON Array)
[{"type": "open", "question": "What do you think?"}]
Survey Type
Select...
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
Responses Limit
1000
Update Survey (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
idstringSurvey ID
namestringSurvey name
descriptionstringSurvey description
typestringSurvey type (popover or api)
questionsarraySurvey questions
created_atstringCreation timestamp
start_datestringSurvey start date
end_datestringSurvey end date

List Session Recordings

Operation
List Session Recordings
Region
Select...
Limit
100
Offset
0
List Session Recordings (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
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

Get Session Recording

Operation
Get Session Recording
Region
Select...
Recording ID*
Session Recording ID
Get Session Recording (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
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

List Recording Playlists

Operation
List Recording Playlists
Region
Select...
Limit
100
Offset
0
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
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
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

List Event Definitions

Operation
List Event Definitions
Region
Select...
Limit
100
Offset
0
Search
Search query
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
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
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

Get Event Definition

Operation
Get Event Definition
Region
Select...
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
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

Update Event Definition

Operation
Update Event Definition
Region
Select...
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
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

List Property Definitions

Operation
List Property Definitions
Region
Select...
Limit
100
Offset
0
Search
Search query
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
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
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

Get Property Definition

Operation
Get Property Definition
Region
Select...
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
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

Update Property Definition

Operation
Update Property Definition
Region
Select...
Property Definition ID*
Property Definition ID
Description
Enter description
Tags (comma-separated)
tag1, tag2, tag3
Property Type
Select...
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
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

List Projects

Operation
List Projects
Region
Select...
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
ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)
Output
ParameterTypeDescription
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

Get Project

Operation
Get Project
Region
Select...
Project ID*
Enter your PostHog project ID
Project ID*
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
ParameterTypeRequiredDescription
projectIdstringYesProject ID (numeric ID or UUID)
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)
Output
ParameterTypeDescription
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

List Organizations

Operation
List Organizations
Region
Select...
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
ParameterTypeRequiredDescription
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)
Output
ParameterTypeDescription
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

Get Organization

Operation
Get Organization
Region
Select...
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
ParameterTypeRequiredDescription
organizationIdstringYesOrganization ID (UUID)
apiKeystringYesPostHog Personal API Key
regionstringNoCloud region: us or eu (default: us)
Output
ParameterTypeDescription
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

Usage Instructions

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

Notes

  • Category: tools
  • Type: posthog