Skip to main content
PostHog
490 actions · 10 events · 2 auth methods
AnalyticsIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

MCP (OAuth) · Connector Profile

Authorize through the MCP server. Endpoints and client registration are discovered at connect time.

API Key · Connector Profile

Admin access required to generate personal API keys
Optionally, configure receiving Events for PostHog into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

MCP (OAuth) · Link Account

API Key · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
|
490 actions
Action
Description
Required scopes
List All Actions
Retrieve a list of all actions
Create Actions
Create a new action
Retrieve An Action
Retrieve details of a specific action
Update An Action
Update an action’s configuration
Delete An Action
Delete an action (soft delete)
List All Activity Log
Retrieve activity log entries for a project
List All Alerts
Retrieve a list of all alerts
Capture Event
Send a single event to PostHog
Capture Batch Events
Send multiple events to PostHog in a single request
List All Dashboards
Retrieve a list of all dashboards
Create Dashboards
Create a new dashboard
Retrieve A Dashboard
Retrieve details of a specific dashboard
Update A Dashboard
Update a dashboard’s configuration
List Event Definitions
Retrieve a list of event definitions in a project
Retrieve An Event Definition
Retrieve details of a single event definition
List Property Definitions
Retrieve a list of property definitions in a project
Retrieve A Property Definition
Retrieve details of a single property definition
List All Feature Flags
Retrieve a list of all feature flags
Create Feature Flags
Create a new feature flag
Retrieve A Feature Flag
Retrieve details of a specific feature flag
Update A Feature Flag
Update a feature flag’s configuration
List All Groups Types
Retrieve a list of all group types
Delete Groups Types
Delete a group type
List All Groups Types Metrics
Retrieve metrics for a specific group type
Create Groups Types Metrics
Create a new metric for a group type
Retrieve Groups Types Metrics
Retrieve details of a specific group type metric
Update Groups Types Metrics
Update a group type metric’s configuration
Delete Groups Types Metrics
Delete a group type metric
Update Groups Types Update Metadata
Update group types metadata
Get Unified Credentials
Get the current PostHog connection’s unified credentials and identity.
List Unified Organizations
List unified organizations in PostHog.
Get Unified Organization
Get a unified PostHog organization by ID.
List Unified Resource Types
Return the resource types PostHog supports for resource-scoped IAM queries.
List Unified Resource Users
List the members of a PostHog organization with their membership-level role attached.
List Unified Roles
List unified roles in PostHog.
Get Unified Role
Get a unified PostHog role by ID.
List Unified Users
List unified users in PostHog.
Get Unified User
Get a unified PostHog user by ID.
List All Insights
Retrieve a list of all insights
Create Insights
Create a new insight
Retrieve An Insight
Retrieve details of a specific insight
Update An Insight
Update an insight’s configuration
Delete An Insight
Delete an insight (soft delete)
Get Organizations
Fetches the organizations that the user has access to, with their id, name, and membership level. Use this to discover o…
Get Projects
Fetches projects that the user has access to in the current organization.
Create Event Definition
Create an event definition for an event that has not been ingested yet. Use this to define the event name, description,…
Get Event Definition
Get one event definition by its exact name, like ‘$pageview’ or ‘user_signed_up’. Returns the description, owner, tags,…
Update Event Definition
Update event definition metadata. Can update description, owner, tags, mark status as verified or hidden. Use exact even…
Update Property Definition
Update property definition metadata. Can update description, tags, property type (DateTime, String, Numeric, Boolean, Du…
Get Feature Flag Definition By Key
Get a feature flag by its string key (e.g. “new-checkout”) — the identifier used in code and shown in the UI. Use this w…
Get Experiment Results
Run an experiment’s metric queries and return primary/secondary metric results plus exposure data in one call, with self…
Get Experiment By Flag Key
Get an experiment by its feature flag key (e.g. “new-checkout”) — the identifier used in code and shown in the UI. Use t…
Query Insight
Execute a saved insight’s query and return results. THIS IS THE ONLY WAY TO RETRIEVE INSIGHT RESULTS — the insights-list…
Get LLM Costs
Fetch daily LLM cost per model for the project over the last N days (default 7). Runs a trends query summing $ai_total_c…
Add Notebook Cell
Add a cell to a markdown notebook. SQL and Python cells run as soon as they are added: the call waits up to ~45s and ret…
Create Markdown Notebook
Create a notebook for deep, step-by-step data analysis: query PostHog and connected data warehouse data with SQL (HogQL)…
Delete Notebook Cell
Delete a cell from a markdown notebook by node_id. Nothing downstream is touched: the response lists orphaned_dependents…
Run Notebook
Run every SQL and Python cell of a markdown notebook, in document order, in one call. Cells run one at a time, and the r…
Run Notebook Cell
Run one SQL or Python cell of a markdown notebook as it is, by node_id. Use it to run a cell added with run: false, to r…
Notebook Run Status
Keep waiting on a notebook run that notebooks-run started, and write each cell’s result into the document as it lands. W…
Update Notebook Cell
Update a cell by node_id. For a SQL or Python cell pass code to replace its source and re-run it. To run a cell unchan…
Execute SQL Query
Executes HogQL — PostHog’s variant of SQL that supports most of ClickHouse SQL. “HogQL” and “SQL” are used interchangeab…
Read Data Schema
Use this tool to explore the user’s data schema. The user implements PostHog SDKs to collect events, properties, and pro…
List Sync Jobs For A Source
List sync job history for a data warehouse source. Returns jobs sorted by most recent first, with status, duration, rows…
Enable Workflow
Enable / activate a draft workflow and start processing events. From then on it runs on real people: test it first with…
Archive Workflow
Archive a workflow — sets its status to ‘archived’, retiring it from active use while keeping it readable via workflows-…
Run Batch Workflow
Broadcast a batch workflow to its matching users NOW — sends real messages/webhooks, not a test. Workflow must be enable…
Schedule Workflow Runs
Attach a recurring RRULE schedule to a workflow with a ‘batch’ or ‘schedule’ trigger (iCalendar RRULE, e.g. ‘FREQ=WEEKLY…
Create Action
Create a new action in the project. Actions define reusable event triggers based on page views, clicks, form submissions…
Delete Action
Delete an action by ID (soft delete - marks as deleted). The action will no longer appear in lists but historical data i…
Get Action
Get a specific action by ID. Returns the action configuration including all steps and their trigger conditions.
Update Action
Update an existing action by ID. Can update name, description, steps, tags, and Slack notification settings.
Get All Actions
Get actions in the project. Actions are reusable event definitions that can combine multiple trigger conditions (page vi…
Archive Dataset
Archive a dataset by ID. Its revisions and items remain readable, but item mutations are rejected until the dataset is r…
Create Dataset
Create an empty dataset in the current project. Dataset names are unique within a project. The first immutable revision…
Get Dataset
Retrieve an active or archived dataset by UUID, including its metadata and latest committed revision.
Archive Dataset Item
Archive an active dataset item by stable item ID. Pass its current version as base_version to prevent a stale write. T…
Create Dataset Item
Add an item to a dataset and create its first immutable version. input accepts any non-null JSON value. Use `expected_…
Get Dataset Item
Retrieve the current immutable version of an active or archived dataset item by its stable item UUID. Pass revision to…
List Dataset Items
List active items in a dataset by default. Set archived to list archived items, or pass revision to inspect the exac…
Update Dataset Item
Update an active item by stable item ID. Pass its current version as base_version to prevent a stale write. Each updat…
List Datasets
List active datasets in the current project by default. Filter by search text, UUIDs, or tags, or set archived to list…
Restore Dataset
Restore an archived dataset by ID. This makes item mutations available again without changing item states or creating a…
Update Dataset
Update an active dataset’s name, description, or metadata by ID. These descriptive changes do not create a dataset revis…
Get Evaluation Config
Retrieve the team’s evaluation config and active provider key. Call before creating an llm_judge eval to confirm a provi…
Create Evaluation
Create an evaluation. ‘llm_judge’: set evaluation_config.prompt and model_configuration with provider and model; provide…
Delete Evaluation
Soft-delete an AI observability evaluation. The evaluation stops running and is hidden from list views. Historical evalu…
Get Evaluation
Get a specific AI observability evaluation by its UUID. Requires the evaluation id (UUID) as a parameter — if you don’…
List Supported Llm_judge Models
List provider+model combinations supported for llm_judge. Call it with no arguments to get every supported provider and…
List Evaluations
List all AI observability evaluations for the current project. Optionally filter by name/description search or enabled s…
Create Evaluation Report Config
Create an evaluation report configuration. Reports summarize recent evaluation runs (using AI) and are delivered to emai…
Trigger Evaluation Report Generation
Immediately trigger an AI-generated evaluation report for this report config. Enqueues a Temporal workflow that analyzes…
Get Evaluation Report Config
Get a specific evaluation report configuration by UUID. Returns the full config including frequency, delivery targets, t…
List Evaluation Report Configs
List all evaluation report configurations for the current project. Optionally filter by evaluation UUID using the ‘evalu…
List Evaluation Report Runs
List the run history for a specific evaluation report config. Each run record includes the generated report content, the…
Run Evaluation
Manually trigger an evaluation run for a specific $ai_generation event. Enqueues a Temporal workflow that asynchronously…
Update Evaluation
Partially update an AI observability evaluation. Requires the evaluation id (UUID). If you don’t have it, call llma-ev…
Create Prompt
Create a new LLM prompt for the current team. Requires a unique name and prompt content (string or JSON object). Optiona…
Get Prompt
Get a specific LLM prompt by name. Requires prompt_name, which takes either the prompt’s exact name or the id UUID f…
Set Prompt Label
Point a label (for example ‘production’) at a specific version of an LLM prompt. A label is a movable pointer to exactly…
List Prompts
List all LLM prompts stored for the current team. Optionally filter by name. Pass label (e.g. ‘production’) to get eac…
Update Prompt
Publish a new version of an existing LLM prompt by name. Name is immutable after creation. You can either provide the fu…
Get LLM Provider Key
Fetch one LLM provider key by ID — its provider, name, and validation state, with a masked preview (never the secret). U…
List LLM Provider Keys
List the team’s configured LLM provider keys (OpenAI, Anthropic, Azure, etc.). Returns each key’s provider, name, valida…
Create Scorer
Create a new scorer (a.k.a. score definition) used by trace reviews. Pass name, kind (categorical, numeric, or `…
Get Scorer
Retrieve a scorer by ID, including its current immutable config payload, current_version number, kind, archived stat…
List Scorers
List active scorers for the current project. By default only active rows are returned — pass archived=true to see only…
Bump Scorer To A New Version
Publish a new immutable config version for an existing scorer. Use this whenever the scoring rules change (add/remove…
Update Scorer Metadata
Update a scorer’s metadata: rename via name, edit description, or toggle archived to hide (true) or restore (`fa…
Get Scorer Version
Retrieve an exact immutable scorer version by definition id and version_id UUID. Its pinned config determines how histor…
List Scorer Versions
List immutable versions of a scorer definition, newest first, including versions with no recent results and archived sco…
Create Trace Review
Save a trace review. Supports an optional comment, an optional scores array, and an optional queue_id to clear a matchin…
Delete Trace Review
Delete a trace review by ID. This soft-deletes the review so the same trace can be reviewed again later if needed.
Get Trace Review
Retrieve a saved trace review by ID. Returns the trace_id, comment, scores, creator, reviewer, and timestamps.
List Trace Reviews
List saved trace reviews. Supports filtering by trace_id, definition_id, search, and ordering. Returns comments, scores,…
Update Trace Review
Update a trace review. Pass comment and/or the full desired scores array. You can also pass queue_id to clear only a mat…
List LLM Traces
List LLM traces to inspect AI/LLM usage across your application. Returns traces with their events, latency, token usage,…
Get LLM Trace
Fetch a single LLM trace by its trace ID for deep inspection. Returns the trace and every nested event, with model param…
Create Alert
Create a new alert on an insight. Alerts can use either threshold-based conditions or anomaly detection. For threshold a…
Delete Alert
Delete an alert by ID. This permanently removes the alert and all its check history. Subscribed users will no longer rec…
Send An Alert To Slack
Post this insight alert to a Slack channel as well as emailing its subscribed users. The Slack workspace must already be…
Stop Sending An Alert To Slack
Remove a destination from an insight alert by passing the hog_function_ids that alert-destinations-create returned. The…
Get Alert
Get a specific alert by ID. Returns the full alert configuration including check results, threshold settings, detector_c…
Simulate Detector On Insight
Run an anomaly detector on an insight’s historical data without creating any alert or check records. Use this to preview…
Update Alert
Update an existing alert by ID. Can update name, threshold, condition, config, detector_config, subscribed users, enable…
List Alerts
List all insight alerts in the project. Returns alerts with their current state, threshold or detector configuration, ti…
Create Annotation
Create an annotation to mark an important change (for example, a deployment) on charts and trends. Provide a note in `co…
Delete Annotation
Soft-delete an annotation by ID. This hides the annotation from normal lists while preserving historical records.
Retrieve Annotation
Retrieve a single annotation by ID from the current project. Use this when you already know the annotation ID and want c…
List Annotations
List annotations in the current project, newest first. Use this to review existing deployment markers and analysis notes…
Update Annotation
Update an existing annotation by ID. You can change its text (content), when it happened (date_marker, ISO 8601), it…
List Recent Production Changes
List the changes that can affect production in a time window, newest first: feature flag and experiment edits, error tra…
Create Batch Export
Create a new batch export. This tool supports typed destination configs for Databricks, AzureBlob, BigQuery, Postgres, A…
Delete Batch Export
Soft-delete a batch export. Stops all future scheduled runs and hides the export from list and get operations. Historic…
Get Batch Export
Get a batch export by ID. Returns full non-sensitive configuration including destination type and config, linked integra…
Update Batch Export
Partially update a batch export. Top-level fields (name, paused, interval, timezone, offset_day, offset_hour, incrementa…
List Batch Exports
List batch exports in the project. Batch exports send event, person, session data, or HogQL query results to destination…
Get Billing Overview
Fetch the organization’s current billing state: subscribed products and addons, available features, plan tier, usage sum…
Get Spend Breakdown
Fetch time-series spend (cost in USD) breakdowns for the organization across a date range. Same dimensional parameters a…
Get Usage Breakdown
Fetch time-series usage breakdowns for the organization across a date range. Supports per-team (project) and per-usage-t…
List Function Templates
List available function templates. Templates are pre-built function configurations for common integrations (Slack, webho…
Get Function Template
Get a specific function template by its template ID (e.g. ‘template-slack’, ‘template-geoip’). Returns the full template…
Create Function
Create a new function. Requires ‘type’ (destination, site_destination, internal_destination, source_webhook, warehouse_s…
Delete Function
Delete a function by ID (soft delete). The function will no longer appear in lists or process events, but historical dat…
Test-invoke Function
Test-invoke a function with a mock event payload. Sends the function configuration and test data to the plugin server fo…
List Functions
List all functions (destinations, transformations, site apps, and source webhooks) in the project. Returns each function…
Get Function Logs
Retrieve execution logs for a specific CDP function by ID. Returns log entries with timestamp, level (DEBUG, LOG, INFO,…
Get Function Metrics
Retrieve execution metrics for a specific CDP function by ID. Returns time-series data showing success and failure count…
Update Function
Partially update a function. Can enable/disable the function, change its name, description, source code, inputs, filters…
Publish Staged Changes
Apply the config staged on a function to what is actually running. Two steps, and the first is mandatory on an enabled f…
Get Function
Get a specific function by ID. Returns the full configuration including source code, inputs schema, input values (secret…
Add Persons To Static Cohort
Add persons to a static cohort by their UUIDs. Only works for static cohorts (is_static: true). ‘person_ids’ must be per…
Create Cohort
Create a cohort (a saved group of persons). Two kinds: - Dynamic cohort (default): provide ‘filters’ with AND/OR groups…
List All Cohorts
List all cohorts in the project. Returns a summary of each cohort including id, name, description, count (person count)…
Update Cohort
Update an existing cohort’s name, description, or filters. Changing filters on a dynamic cohort triggers recalculation…
Get Cohort
Get a specific cohort by ID. Returns the cohort name, description, filters (for dynamic cohorts), count of matching user…
Remove Person From Static Cohort
Remove a person from a static cohort by their UUID. Only works for static cohorts (is_static: true). The person must exi…
Start A Support Ticket By Email
Create a new outbound email ticket and send its first message to the recipient. The message IS EMAILED to the customer i…
List Support Tickets
List support tickets in the project. Supports filtering by status (new, open, pending, on_hold, resolved), priority (low…
Read Support Ticket Messages
Return a support ticket’s message thread, ordered chronologically. The response is paginated (default 50, max 200 per pa…
Delete Private Note
Soft-delete a private note on a support ticket. Only private notes authored by the calling user can be deleted. Customer…
Update Private Note
Update a private note on a support ticket. Only private notes authored by the calling user can be edited. Customer-facin…
Reply To Support Ticket
Post a reply or internal note to a support ticket. IMPORTANT: With is_private=false (the default), the reply IS DELIVERE…
Get Support Ticket
Get a specific support ticket by ID or ticket number. Returns full ticket details including status, priority, assignee,…
Update Support Ticket
Update a support ticket. Can change status (new, open, pending, on_hold, resolved), priority (low, medium, high, critica…
Create Saved Ticket View
Create a saved ticket view: a named, reusable set of ticket filters. filters accepts status, priority, channel, sla, a…
List Saved Ticket Views
List the saved ticket views in the project. Each view is a named, saved set of ticket filters — for example the per-team…
Get Saved Ticket View
Get a saved ticket view by its short_id, including the full filters object that conversations-views-list omits. Read t…
Update Saved Ticket View
Update a saved ticket view by its short_id. Can change the name, the saved filters, and is_favorited. Sending `filters…
Create Project
Create a project in the caller’s active organization. A project is a separate data container with its own API token, so…
Get Project
Retrieve a project and its settings. Omit the ID to get the caller’s active project. This is the one tool that returns t…
Update Project Settings
Update a project’s settings using PATCH semantics — only the fields included in the request body are changed. Use `proje…
Get User
Retrieve the authenticated user’s own profile and settings — identity (id, uuid, distinct_id, email, name), security/aut…
Update User Settings
Update the authenticated user’s profile and settings using PATCH semantics — only the fields included in the request bod…
Create Usage Metric
Create a new usage metric for the project. The metric surfaces on both group and person Customer Analytics profile pages…
Delete Usage Metric
Permanently delete a usage metric by id. Pass group_type_index: 0 — usage metrics apply to both groups and persons reg…
List Usage Metrics
List usage metrics defined for the project. Usage metrics apply to both groups and persons on Customer Analytics profile…
Update Usage Metric
Update fields on an existing usage metric. Accepts a subset of fields; unspecified fields are left unchanged. filters…
Get Usage Metric
Fetch a single usage metric by id. Pass group_type_index: 0 — usage metrics apply to both groups and persons regardles…
Create Dashboard
Create a new dashboard. Provide a name and optional description, tags, and pinned status. All viewers see the descriptio…
Create Dashboard Tile
Add a dashboard tile. Set type to text or image. Use Markdown headings, dividers, or notes for a text tile. The deskto…
Delete Dashboard
Delete a dashboard by ID. The dashboard will be soft-deleted and no longer appear in lists.
Delete Dashboard Tile
Soft-delete a single tile (text, insight, widget, or button) from a dashboard. Behaves the same as the delete button in…
Get Dashboard
Get a specific dashboard by ID. Returns the dashboard with all its tiles: insight IDs, short IDs, names and descriptions…
Run Dashboard Insights
Run all insights on a dashboard and return their results. Uses cached results by default (may be stale); set refresh to…
Reorder Dashboard Tiles
Reorder tiles on a dashboard by providing an array of tile IDs in the desired display order. First, use dashboard-get to…
List Dashboard Templates
List available dashboard templates and use them as reference material for dashboards on a topic such as product analytic…
Get Dashboard Template
Get a single dashboard template by ID, including its full tiles (each tile’s insight query and layout) and variables…
Copy Dashboard Tile
Copy an insight, text card, or widget tile from one dashboard to another. The path dashboard ID is the destination. Prov…
Transfer Dashboard Tile
Transfer a tile from the source dashboard to another dashboard. This does not resize or reposition the tile. To resize o…
Update Dashboard
Resize, reposition, or update dashboard tiles. It can also update the dashboard name, description, pinned status, tags,…
Update Dashboard Text Tile
Update the user-facing markdown body, agent context, layout, or color of an existing text tile on a dashboard. Pass the…
Delete Dashboards In Bulk
Soft-delete up to 100 dashboards by ID. Saved insights are kept by default. Set delete_insights to true to also delete i…
Get All Dashboards
List dashboards in the project. The optional search parameter runs a fuzzy match against name and description using Po…
Describe A Governed Metric
Inspect the full semantic-layer definition for one metric, addressed by the name returned from metric-list. The response…
List Governed Metrics
List every governed business and telemetry metric in the team’s semantic layer. Call this before a typed domain tool or…
Add A View Column Description
Add or replace a semantic description for a data-modelling view (saved query) or one of its columns. Use this ONLY for v…
List View Column Descriptions
List semantic descriptions of data-modelling views (saved queries) and their columns. Use this for views (table_type = ’…
Create Saved Query
Create a new data warehouse saved query (view). If a view with the same name already exists, it will be updated instead…
Delete Saved Query
Delete a data warehouse saved query (view) by ID. This is a soft delete — the view is marked as deleted and will no long…
Get Saved Query
Get a specific data warehouse saved query (view) by ID. Returns the full view definition including the HogQL query, colu…
List Saved Queries
List all data warehouse saved queries (views) in the project. Returns each view’s name, materialization status, sync fre…
Materialize Saved Query
Enable materialization for a saved query. This creates a physical table from the view’s query and sets up a sync schedul…
Resume Suspended Materialization
Resume a saved query whose materialization was suspended after repeated failures. Scheduled runs skip a suspended view a…
Run Saved Query
Trigger a manual materialization run for a saved query. By default, this refreshes only the selected view. Set direction…
Get Run History
Get the 5 most recent materialization run statuses for a saved query. Each entry includes the run status and timestamp…
Revert Materialization
Undo materialization for a saved query. Deletes the materialized table and removes the sync schedule, reverting the view…
Update Saved Query
Update an existing data warehouse saved query (view). Can change the name, HogQL query, sync frequency, or description…
Add A Warehouse Column Description
Add a semantic description for a data warehouse table or column. Provide the table id, the column_name (empty string for…
List Warehouse Column Descriptions
List semantic descriptions of data warehouse tables and columns. Pass ?table_id=<uuid> to scope to one table. Each entry…
Edit A Warehouse Column Description
Update the description of an existing warehouse table or column annotation by its id. The annotation is marked user-edit…
Link A Bucket As A Warehouse Table
Make files in the user’s own S3-compatible bucket queryable as a warehouse table, without an import pipeline or a recurr…
Refresh Table Schema From Source
Re-introspect a self-managed (manually linked) data warehouse table’s schema from its underlying source files and overwr…
Search Documentation
Use this tool for any PostHog questions to search the documentation. If the user’s question mentions multiple topics, se…
Create Early Access Feature
Create a new early access feature. A feature flag is automatically created unless feature_flag_id is provided. Stage det…
Delete Early Access Feature
Delete an early access feature by ID. Clears enrollment conditions from the linked feature flag but does not delete the…
List Early Access Features
List early access features in the current project. Returns name, stage, description, linked feature flag, and creation d…
Update Early Access Feature
Update an early access feature by ID. Changing the stage automatically updates the linked feature flag’s enrollment cond…
Get Early Access Feature
Get a single early access feature by ID. Returns full details including the linked feature flag configuration.
Create Endpoint
Create a new API endpoint from a HogQL or insight query. The name must be URL-safe (letters, numbers, hyphens, underscor…
Delete Endpoint
Delete an endpoint by name. The endpoint is soft-deleted and its materialized views are cleaned up.
Get Endpoint
Get a specific endpoint by name. Returns the full endpoint configuration including query definition, version info, mater…
Get Materialization Status
Get lightweight materialization status for an endpoint without fetching full endpoint data. Returns whether materializat…
Get Endpoint OpenAPI Spec
Get the OpenAPI 3.0 specification for an endpoint. Returns a JSON spec that can be used with SDK generators like openapi…
Run Endpoint
Execute an endpoint’s query and return results. Uses materialized results when available, otherwise runs inline. For Hog…
Update Endpoint
Update an existing endpoint by name. Can update the query (auto-creates a new version), description, data freshness, act…
Get Endpoint Versions
List all versions for an endpoint, in descending order (latest first). Each version contains the query snapshot, descrip…
Get All Endpoints
Get all API endpoints in the current project. Endpoints expose saved HogQL or insight queries as callable API routes. Re…
Get Endpoints Last Execution Times
Get the most recent execution time per endpoint (endpoint-level, personal API key calls only). Pass an array of endpoint…
Preview Endpoint Materialization
Preview the materialization transform for an endpoint before enabling it. Returns the transformed HogQL, detected range…
Create Error Tracking External Reference
Create a new external issue in GitHub, GitLab, Linear, or Jira, then link it to a PostHog error tracking issue as an ext…
Assign Error Tracking Issue
Assign an error tracking issue to an organization member or role. Provide the issue ID as id and set assignee to a u…
Merge Error Tracking Issues
Merge one or more error tracking issues into an existing target issue. Provide the target issue as id and the issues t…
Update Error Tracking Issue
Update an error tracking issue’s status, severity, name, or description. Use `error-tracking-issues-assign-partial-updat…
Split Error Tracking Issue Fingerprints
Split one or more fingerprints out of an existing error tracking issue into new issues. Provide the source issue as id…
List Error Tracking Recommendations
List error tracking recommendations for the current project. Each row is a server-computed suggestion with a fixed `type…
Get Error Tracking Settings
Get the error tracking ingestion settings for the current project. Returns ingestion_enabled, which is false when inge…
Update Error Tracking Settings
Update the error tracking ingestion settings for the current project. Only the fields you include are applied; omitted f…
Download Error Tracking Symbol Set
Get a presigned download URL for a source map symbol set by ID. The URL expires after one hour. Use it immediately, and…
List Error Tracking Symbol Sets
List source map symbol sets for the current project. Supports pagination plus filtering by exact ref or upload `status…
Get Error Tracking Symbol Set
Get a source map symbol set by ID. If you only have a symbol set reference, call error-tracking-symbol-sets-list with…
Query Error Tracking Issue
Get compact details for one Error tracking issue. Use this after query-error-tracking-issues-list when you have an `is…
Query Error Tracking Issue Events
Fetch sampled $exception events for one Error tracking issue. Use this when the user asks for concrete examples, stack…
Query Error Tracking Issues List
List and filter Error tracking issues. Returns compact issue rows with aggregate impact counts (occurrences, users,…
Create Error Tracking Alert
Create an error tracking alert that fires when an issue is created, reopened, or starts spiking. An alert is a HogFuncti…
Delete Error Tracking Alert
Delete an error tracking alert by ID (soft delete). The alert stops firing immediately, but the HogFunction row and its…
List Error Tracking Alerts
List error tracking alerts in the project. Pass type=internal_destination and inspect each entry’s filters.events fo…
Update Error Tracking Alert
Partially update an error tracking alert. Use to enable or disable an alert, rename it, change the destination channel/U…
Get Experiment Change History
Get the audit trail for a specific experiment by ID. Returns a paginated list of changes to the experiment, its holdouts…
Archive Experiment
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Calculate Experiment Running Time
Estimate the recommended sample size and how many days an experiment needs to run to detect an effect. This is a statele…
Create Experiment
RULES (follow before calling): 1. Load the creating-experiments skill for the full creation workflow. 2. If the user…
Delete Experiment
Delete an experiment by ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
End Experiment
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Get Experiment Details
Get a single experiment by ID. If you have the experiment’s feature flag key instead of its ID, call experiment-get-by-f…
Create Experiment Holdout
Create a holdout group — a reserved slice of users excluded from experiment exposure, used as a held-back baseline. Requ…
Delete Experiment Holdout
Delete a holdout group by ID. Use experiment-holdouts-list first if you don’t have the ID, and always confirm by name be…
List Experiment Holdouts
List the experiment holdout groups in the current project. A holdout reserves a stable slice of users who are excluded f…
Get Experiment Holdout Details
Get a single experiment holdout group by ID, including its name, description, and filters array (the held-out population…
Launch Experiment
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Get All Experiments
List experiments in the current project. This is the primary tool for resolving experiment references — load the finding…
Pause Experiment
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Reset Experiment
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Resume Experiment
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Create Shared Experiment Metric
Create a reusable shared metric. Requires name (unique per project, case-insensitive) and query (kind=‘ExperimentMetric’…
Delete Shared Experiment Metric
Delete a shared metric by ID. REQUIRES EXPLICIT USER CONFIRMATION — confirm by name first, and warn that any experiments…
List Shared Experiment Metrics
List shared metrics in the current project. Returns paginated results with id, name, description, query, created_at, upd…
Get Shared Experiment Metric
Get a single shared metric by ID. Returns the full query JSON (metric_type, source, math, filters, etc.). If you don’t h…
Ship Experiment Variant
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Get Experiment Velocity Stats
Get aggregate experiment velocity statistics for the current project. Returns: launched_last_30d (experiments launched i…
Get Experiment Metric Results Over Time
Only for the day-by-day history of a SINGLE metric — how its results moved over the course of the experiment. For an exp…
Unarchive Experiment
Requires an experiment ID. If you don’t have the ID, load the finding-experiments skill to resolve the user’s reference…
Update Experiment
RULES (follow before calling): 1. If changing rollout or variants on a RUNNING experiment, you MUST warn the user abo…
Create Feature Flag
Create a feature flag in the current project. Call when the user asks to add a flag, gate a feature behind a flag, set u…
Delete Feature Flag
Soft-delete a feature flag by ID in the current project. A flag whose filters.version is 2 requires version, so read…
Archive Feature Flag
Archive a feature flag, hiding it from the default flag list. Requires the flag’s numeric ID; use `feature-flag-get-defi…
Disable Feature Flag
Turn a feature flag off. Requires the flag’s numeric ID; use feature-flag-get-definition-by-key to get it from a key,…
Enable Feature Flag
Turn a feature flag on. Requires the flag’s numeric ID; use feature-flag-get-definition-by-key to get it from a key, o…
Get All Feature Flags
Get feature flags in the current project. Supports list filters including search by feature flag key or name (case-insen…
Get Feature Flag Definition
Get a single feature flag’s full definition — rollout conditions, variants, payloads, active state — by its numeric ID…
Roll Feature Flag Out To Everyone
Serve a feature flag to its whole audience: every user, or every group of the configured type when the flag aggregates b…
Set Feature Flag Release Condition Rollout
Set what percentage of one release condition’s audience a feature flag is served to. Requires the flag’s numeric ID; use…
Unarchive Feature Flag
Restore an archived feature flag to the default flag list. Requires the flag’s numeric ID; pass &#123;"archived":"true"&#125; to…
Bulk Delete Feature Flags
Soft-delete multiple feature flags in one call. Provide either ids (explicit list of flag IDs) OR filters (same shap…
Look Up Feature Flag Keys By ID
Resolve feature flag IDs to their string keys in one call. Pass ids as a list of integer flag IDs. Returns keys as a…
Check Whether A Flag’s Dependencies Can Be Copied
Preview what a cross-project copy would do to a flag’s transitive flag dependencies. Copies nothing and changes nothing…
Copy Feature Flag Across Projects
Copy a feature flag from one project to other projects within the same organization. Provide the flag key, source projec…
Get Dependent Feature Flags
Get other active feature flags that depend on this flag. Use this to understand flag dependency chains before making cha…
Get Feature Flag Evaluation Reasons
Debug why feature flags evaluate a certain way for a given user. Provide a distinct_id and optionally groups to see each…
Get My Evaluated Feature Flags
List feature flags in the current project along with their evaluated value for the authenticated user (the API key owner…
Get Feature Flag Status
Check the health and evaluation status of a feature flag by ID. Returns a status (active, stale, deleted, or unknown) an…
Test Feature Flag Evaluation
Simulate how one feature flag (by numeric ID) would evaluate for a specific user, optionally at a past point in time (`t…
Update Feature Flag
Update a feature flag by numeric ID (partial update: only the fields you include are changed). Use this for edits that h…
Get A Health Issue
Fetches a single health issue by id so you can drill into what’s wrong AND explain how to fix it. Alongside the issue’s…
List Health Issues
Lists health issues detected across all of this project’s PostHog health checks — outdated SDKs, data warehouse sync fai…
Summarize Health Issues
Returns aggregated counts of active, non-dismissed health issues for the project, broken down by severity and by kind. U…
Create Log Alert
Create a threshold-based alert on log streams. The alert periodically counts log entries matching the given filters and…
Attach Alert Destination
Attach a Slack, webhook, Microsoft Teams, or PagerDuty notification destination to a log alert. Without a destination an…
Detach Alert Destination
Remove a notification destination from a log alert by passing the hog_function_ids returned from logs-alerts-destination…
Delete Log Alert
Permanently delete a log alert configuration by ID.
List Alert Events
List historical events for a log alert — fires, resolves, errors, enable/disable toggles, threshold changes. Use to eval…
List Log Alerts
List log alert configurations in the current project, newest first. Returns alert name, state, threshold, filters, and s…
Update Log Alert
Update a log alert configuration by ID. Only the fields you provide are changed. Use this to adjust thresholds, filters,…
Get Log Alert
Get a log alert configuration by ID. Returns full details including current state, threshold settings, filters, and sche…
List Log Attribute Values
List values for a specific log attribute key. Use to discover what values exist before building filters. Defaults to att…
List Log Attributes
List available log attribute names for filtering. Defaults to attribute_type “log” (log-level attributes). To search res…
Count Logs
Return a scalar count of log entries matching a filter set. Use this as a cheap pre-flight before query-logs — if the…
Facet Log Counts
Return per-value counts for a single facet — the distribution of a log dimension across a filter set, ordered by count d…
Mine Log Patterns
Mine recurring log templates (“patterns”) from the logs matching a filter set, ordered by frequency. Each pattern is a m…
List Services With Health Status
List every service that logged in the window, with its health against a baseline. All other parameters go inside query…
Break Down MCP Tool Calls By Harness
Group this project’s MCP tool-call activity by the resolved client harness — the friendly product label for the MCP clie…
Summarise One MCP Tool
Return the headline numbers for a single MCP tool over the window: total calls, error count, p50 and p95 latency, unique…
Daily Trend For One MCP Tool
Return a day-by-day time series for a single MCP tool: calls, errors, p50/p95 latency, unique users, and unique sessions…
Top Errors For One MCP Tool
Return the most common failure buckets for a single MCP tool, each with the resolved client harness it came from. Failur…
Individual Errored Calls In One Failure Bucket
Return individual errored $mcp_tool_call events for a single MCP tool within one failure bucket, newest first (up to 50)…
Top Callers Of One MCP Tool
Return the top callers of a single MCP tool: per caller, the call count, error rate, resolved harness labels, last-seen…
Tools Called Alongside One MCP Tool
Return the tools most often called immediately before or after a single MCP tool within the same conversation. Pass tool…
Sample Intents For One MCP Tool
Return recent sample agent intents recorded for a single MCP tool, each with its resolved client harness. Pass toolName…
Descriptions Seen For One MCP Tool
Return the distinct effective tool-description strings seen for a single MCP tool over the window. Pass toolName (effect…
List MCP Missing-capability Reports
Return capabilities that agents asked this MCP server for but could not access. Each row contains one $mcp_missing_capab…
Delete Notebook
Delete a notebook by short_id. The notebook will be soft-deleted and no longer appear in lists.
Get Notebook
The full notebook view: title, markdown source, the notebook’s variables (name, type, value; a SQL cell reads one as `{n…
List Notebooks
List all notebooks in the project. Supports filtering by search term, created_by, last_modified_by, date_from, date_to,…
Update Notebook
Update an existing notebook by short_id. Can update title, content, and deleted status. IMPORTANT: when updating the con…
Get Notebook Cell Run Result
Read the durable state of a cell run: status (‘running’, ‘done’, ‘failed’, ‘interrupted’) and, once done or interrupted,…
Bulk Delete Persons
Delete up to 1000 persons by PostHog person UUIDs or distinct IDs. Optionally delete associated events and recordings. P…
Get Person Cohorts
Get all cohorts that a specific person belongs to. Requires the person_id query parameter.
List Persons
List persons in the current project. Supports search by email (full text) or distinct ID (exact match), and filtering by…
Delete Person Property
Remove a single property from a person by key. The property is deleted asynchronously via the event pipeline ($unset).
Set Person Properties
Set properties on a person. Pass key and value for one property, or properties for up to 1000 in a single request, which…
Get Person
Retrieve a single person by numeric ID or UUID. Returns the person’s properties, distinct IDs, and metadata.
Get Person Property Values
Get distinct values for a person property key. Useful for discovering what values exist for properties like ‘plan’, ‘rol…
Get Comment Counts.
Count comments, optionally narrowed to one resource by scope (e.g. Dashboard, Insight, FeatureFlag) and item_id. Use whe…
Get A Specific Comment.
Get a specific comment by ID including its content, rich content with mentions, and metadata.
Get All Replies In A Comment Thread.
Get the full thread of replies for a parent comment. Useful for reading complete discussions on a resource.
Create A Comment Or Reply
Create a comment on an accessible resource, or reply by passing source_comment. For a canvas use scope canvas and th…
List Comments And Discussion Threads.
List comments across the project. Filter by scope (Dashboard, FeatureFlag, Insight, etc.) and item_id to find discussion…
List Organization Members.
List all members of the current organization with their names, emails, membership levels (member, admin, owner), and las…
Get Organization Details.
Get details of an organization by ID including name, membership level, member count, teams, projects, and the plan featu…
List Organizations.
List all organizations the user has access to. Returns org ID, name, slug, and membership level. Use the ID with organiz…
Get A Specific Role.
Get details of a specific role including its name, creation date, and creator.
List Members Of A Role.
List all members assigned to a specific role. Shows who has which role in the organization.
List Organization Roles.
List all roles defined in the organization. Roles group members and can be used in approval policies and access control…
Get Pinned Tabs And Homepage.
Get the authenticated user’s pinned navigation tabs and configured homepage for the current team. The homepage is the pa…
Update Pinned Tabs And Homepage.
Update the authenticated user’s pinned tabs and/or homepage for the current team. Pass @me as the UUID. The homepage c…
List PostHog AI Chat Threads
List the caller’s PostHog AI (Max) chat threads in the project. Threads are ordered by most recent update. Each result h…
Get PostHog AI Chat Thread
Get one PostHog AI (Max) chat thread by id. The response includes the full message thread in the messages field. The t…
Get Element Click Stats
Counts of autocapture clicks, rage clicks, and dead clicks grouped by page element, ordered by count. Each result carrie…
Create Insight
Create a new saved insight from a name and query definition. Test queries with query-trends / query-funnel / query-reten…
Delete Insight
Soft-delete an insight by ID. The insight will be marked as deleted and no longer appear in lists.
Get Insight
Fetch a saved insight by its numeric id or 8-character short_id. Returns the insight metadata and query definition,…
Update Insight
Update a saved insight by numeric id or short_id. Can update name, description, query, tags, favorited status, and d…
Get All Insights
List saved insights in the project with optional filtering by favorited status or search term. Returns metadata only (na…
Get Most-viewed Insights
Returns the most-viewed insights in the project, ranked by view count over the last N days (default 7). Use this to surf…
Run A Trends Query
Run a trends query to analyze metrics over time. Trends insights visualize events over time using time series. They’re u…
Run A Funnel Query
Run a funnel query to analyze conversion rates through a sequence of steps. Funnel insights help understand user behavio…
Run A Retention Query
Run a retention query to analyze how many users return over time after performing an initial action. Retention insights…
Run A Stickiness Query
Run a stickiness query to measure how many intervals (e.g. days) within a date range users performed an event. Stickines…
Run A Paths Query
Run a paths query to analyze the most common sequences of events or pages that users navigate through. Paths insights vi…
Run A Lifecycle Query
Run a lifecycle query to categorize users into lifecycle stages based on their activity pattern relative to a single eve…
List Persons Behind A Trends Data Point
List the persons behind a specific data point in a trends insight. Use this to answer “who were the users that did X on…
List Persons In A Lifecycle Bucket
List the persons in a specific bucket of a lifecycle insight. Use this to answer “who are the new / returning / resurrec…
List Persons On A Paths Insight
List the persons behind a paths insight — either everyone who traversed the path, or those at one specific node/edge. Pa…
List Persons In A Retention Cohort
List the persons in one retention acquisition cohort and show, for each, which subsequent intervals they came back in. P…
List Persons Behind A Stickiness Bar
List the persons behind one bar of a stickiness insight — the users who were active in a given number of intervals. Pair…
List Persons Who Converted Or Dropped Off At A Funnel Step
List the persons behind one step of a funnel insight — either those who converted through it or those who dropped off at…
Bulk Delete Session Recordings
Delete a batch of session recordings by session ID, up to 100 per call. Deletion is permanent and cannot be undone — con…
Delete Session Recording
Delete a session recording by ID. This permanently removes the recording data. Use for privacy or compliance workflows…
Get Session Recording
Get a specific session recording by ID. Returns full recording metadata including duration, interaction counts, console…
Create Session Recording Playlist
Create a new session recording playlist. Set type to ‘collection’ for a manually curated list or ‘filters’ for a saved f…
Get Session Recording Playlist
Get a specific session recording playlist by short_id. Returns full playlist metadata including name, description, filte…
Update Session Recording Playlist
Update an existing session recording playlist by short_id. Can update name, description, pinned status, and filters. Set…
List Session Recording Playlists
List session recording playlists in the project. Returns both user-created and synthetic (system-generated) playlists wi…
List Session Recordings
List session recordings in the project. Returns recording metadata including duration, activity counts, console errors,…
Create Subscription
Create a recurring subscription. The kind is inferred from which field you populate and returned as the read-only `resou…
Delete Subscription
Soft-delete a subscription. Stops all future deliveries and returns the subscription with deleted: true. One-way via M…
List Subscriptions
List the team’s subscriptions. Use search to filter by title, insight name (including the auto-generated name of an un…
Update Subscription
Update a subscription’s mutable fields (title, target, schedule, the prompt for prompt subscriptions, enabled). The…
Get Subscription
Fetch a single subscription by numeric ID. Returns its kind (resource_type: insight, dashboard, or ai_prompt), target…
List AI Summaries For An Insight Or Dashboard
List the AI summaries that subscriptions sent for one insight or dashboard, newest first. Set exactly one of insight o…
Send Test Delivery
Trigger an immediate test delivery of a subscription to its configured target(s) (email, Slack, or Microsoft Teams). Run…
Creates A New Survey In The Project.
Creates a new survey in the project. For the draft, targeting, preview, and launch workflow, load the creating-surveys s…
Delete A Survey By ID.
Delete a survey by ID (soft delete - marks as archived).
Get A Specific Survey By ID.
Get a specific survey by ID. Returns its questions, targeting flag — including current property targeting rules under ta…
Launch A Survey Now.
Launch a survey by setting start_date to the current time. Prefer this over survey-update with a manual start_date…
Get Response Statistics For A Specific Survey.
Get response statistics for a specific survey. Includes detailed event counts (shown, dismissed, sent), unique responden…
Stop A Survey Now.
Stop a survey by setting end_date to the current time. No new responses are accepted after this; existing responses re…
Update An Existing Survey By ID.
Update an existing survey by ID. Omitted top-level fields are preserved, but nested objects and arrays you provide may r…
List Surveys In The Project (server-side Search + Filters).
List surveys in the project. Use search for fuzzy match against survey name and description (handles typos and prefix-…
Get Aggregated Response Statistics Across All Surveys.
Get aggregated response statistics across all surveys in the project. Includes event counts (shown, dismissed, sent), un…
List Individual Survey Responses With Resolved Question Text.
List individual responses for a specific survey. Question text is already resolved server-side — callers do not need to…
Summarize Survey Responses (per Question, Or Survey-wide Headline).
Summarize survey responses using PostHog’s LLM summarization. Pass question_id (preferred) or question_index to get a pe…
Query Tracing Spans
Query trace spans with filtering by service name, status code, date range, and structured attribute filters. Supports cu…
Create A Warehouse Destination
Create a place where warehouse sources write synced rows, from an integration that holds the credentials. Get the integr…
List Warehouse Destinations
List the places this project’s warehouse sources can write synced rows to. The PostHog warehouse is one of them, and it…
Get A Warehouse Destination
Read one warehouse destination, including the target database or schema it writes to. Credentials live on the linked int…
Cancel Running Sync
Cancel a currently running sync job for a specific table schema. If no sync is running, returns an error. Use ‘external-…
List Data Warehouse Table Schemas (imported Tables)
List all table schemas across all data warehouse sources. Each schema represents one table being synced from an external…
Update Data Warehouse Table Schema Sync Config
Update one table schema’s sync configuration: enable/disable syncing (should_sync), sync_type (incremental, full_refresh…
Trigger Sync For A Table Schema
Trigger a sync for a single table schema using its configured sync method (incremental, full refresh, append, or CDC). U…
Resync Table Schema From Scratch
Trigger a full resync for a table schema, discarding all previously synced data and re-importing from the source. This c…
Get Data Warehouse Table Schema
Get a single table schema by ID. Returns full details including sync status, sync frequency, incremental field, primary…
List Direct-query Connections
List external data sources that can be used as a connectionId when running execute-sql against an external source: pure…
Create Data Warehouse Source (advanced; Prefer Source Setup)
Low-level create for a data warehouse import source when you need to hand-pick tables and sync types. If you only have c…
Delete Data Warehouse Source
Delete a data warehouse source and all its table schemas, synced tables, and sync schedules. This is a soft delete. Any…
List Data Warehouse Sources
Check what external data is already connected before answering any revenue, billing, subscription, CRM, support-ticket,…
Update Data Warehouse Source
Update an existing data warehouse source’s prefix (table name prefix in HogQL) or description. Cannot change the source_…
Discover New Tables In Source
Fetch the latest table list from the remote database and create schema entries for any new tables found. This is a metad…
Trigger Sync For A Source
Trigger a sync for all enabled table schemas in the source using each table’s configured sync method. If the source uses…
Get Data Warehouse Source
Get a single data warehouse source by ID. Returns full details including source type, connection status, prefix, all tab…
Get Sessions Behind Heatmap Coordinates
Drill into the individual session interactions behind one or more heatmap coordinates. Pass points as a JSON array of…
List Heatmap Interactions For A Page
Aggregated heatmap interactions captured on a page. Filter by url_exact (one page) or url_pattern (regex across page…
Create A Saved Heatmap
Create a saved heatmap for a page URL. For type ‘screenshot’ (the default) this enqueues a headless render of the page a…
Get A Saved Heatmap
Get a single saved heatmap by its short_id, including per-width render status. Poll this after `heatmaps-saved-creat…
List Saved Heatmaps
List saved heatmaps for the project. A saved heatmap pins a page URL plus a set of viewport widths and (for type ‘screen…
Regenerate A Saved Heatmap Screenshot
Re-run screenshot generation for a saved heatmap of type ‘screenshot’ by its short_id. Clears the existing renders and…
Update A Saved Heatmap
Update a saved heatmap by its short_id. Send only the fields to change — rename via name, change widths, or soft-d…
Run A Web Analytics Overview Query
Run a web analytics overview query — high-level KPIs over a period: visitors, pageviews, sessions, average session durat…
Run A Web Analytics Breakdown Table Query
Run a web analytics breakdown table query — top pages, UTMs, devices, browsers, countries, etc. — with visitors and page…
Run A Web Vitals Path Breakdown Query
Per-page Core Web Vitals breakdown — one metric at one percentile, with pages bucketed into good / `needs_improvements…
Create Workflow
Create a workflow. For one email sent once or on a schedule to an audience (a batch trigger, one email step and an exit)…
Get Workflow
Get a specific workflow by ID, where id is the workflow’s UUID. When you have a workflow’s name instead, resolve it firs…
Get Workflow Invocation
Get a single workflow invocation by invocation_id, including invocation_globals — the raw triggering payload (event/pers…
Workflow Stats Overview
At-a-glance health across ALL workflows in one call: per-workflow succeeded/failed counts over a window (after/before, d…
List Workflows
List all workflows in the project. Returns workflows with their name, description, status (draft/active/archived), versi…
List Workflow Batch Runs
List past batch runs for a workflow (both one-off broadcasts and schedule-triggered runs). Each entry shows the audience…
List Workflow Invocations
List a workflow’s individual invocations (one execution per person/event), each collapsed to its final outcome — status,…
Patch Workflow Graph
Surgically edit a workflow’s graph by sending a small, ordered list of operations instead of resending every action and…
Publish Workflow Draft
Apply a workflow’s staged draft to its live config. Two-step: call without confirm first — it returns in_flight_runs, a…
Get Workflow Stats
Execution stats for a single workflow by ID: time-series success/failure counts over a configurable interval (hour, day,…
Test-run Workflow
Test-invoke a workflow one node at a time; it does NOT traverse the full graph in one call. The result includes nextActi…
Update Workflow
Updates workflow fields a graph patch can’t express: name, description, tags, exit_condition, conversion, trigger_maskin…
Update Workflow Schedule
Update a recurring schedule’s RRULE, start time, timezone, or variable overrides. Changing the cadence reschedules the n…
List All Members
Retrieve a list of organization members
Update Members
Update a member’s details
Delete Members
Remove a member from the organization
Retrieve Organizations
Retrieve a list of organizations
Retrieve An Organization
Retrieve details of a specific organization
Create Organizations
Create a new organization
Update Partial Organization
Update an organization’s settings
Delete Organizations
Delete an organization
List All Integrations
List all organization-level integrations
List Projects
Retrieve a list of all projects in the organization
Retrieve A Project
Retrieve details of a project, including the current one
Retrieve List
List all projects in an organization
Create Projects
Create a new project within an organization
Retrieve An Organization Project
Retrieve details of a specific project
Update Partial Organization Project
Update a project’s configuration
Delete Projects
Delete a project
Change Organization
Move a project to a different organization
Update Complete Product Onboarding
Mark product onboarding as complete
Run A Query
Run a HogQL query against project data
Retrieve A Query Status
Retrieve the status and results of an asynchronous query
Cancel A Query
Cancel a running asynchronous query
List Insight Variables
Retrieve a list of insight variables in a project
Retrieve An Insight Variable
Retrieve details of a single insight variable
Create An Insight Variable
Create a variable that HogQL queries can substitute
Delete An Insight Variable
Delete an insight variable from a project
Update An Insight Variable
Update an existing insight variable
List All Roles
Retrieve a list of all roles
Create Role
Create a new role
Retrieve Role
Retrieve details of a specific role
Update Role
Update a role’s details
Delete Role
Delete a role
List All Role Memberships
List all memberships for a specific role
Create Role Membership
Assign a user to a role
Retrieve Role Membership
Retrieve details of a specific role membership
Delete Role Membership
Remove a user from a role
List All Session Recordings
Retrieve a list of all session recordings
Retrieve A Session Recording
Retrieve details of a specific session recording
Update A Session Recording
Update a session recording’s metadata
Delete A Session Recording
Delete a session recording
List All Users
Retrieve a list of all users
Retrieve Users
Retrieve details of a specific user
Update Users
Update a user’s details
Delete Users
Delete a user
List Warehouse Tables
Retrieve a list of data warehouse tables in a project
Retrieve A Warehouse Table
Retrieve details of a single data warehouse table
Create A Warehouse Table
Create a data warehouse table from files in an S3-compatible bucket
Update A Warehouse Table
Update a data warehouse table
Delete A Warehouse Table
Delete a data warehouse table
List Warehouse Saved Queries
Retrieve a list of saved queries (views) in a project
Retrieve A Warehouse Saved Query
Retrieve details of a single saved query (view)
Create A Warehouse Saved Query
Create a saved query (view) from a HogQL query
Update A Warehouse Saved Query
Update a saved query (view)
Delete A Warehouse Saved Query
Delete a saved query (view)
List Warehouse View Links
Retrieve a list of joins between warehouse tables and PostHog tables
Retrieve A Warehouse View Link
Retrieve details of a single join
Create A Warehouse View Link
Join a warehouse table or view onto another table
Delete A Warehouse View Link
Delete a join between tables

Events

|
10 events
Event
Description
Tags
Pageview
Emits when a $pageview event is captured in PostHog, indicating a page was visited on the web.
PageEvents
Page Leave
Emits when a $pageleave event is captured in PostHog, indicating a visitor left a page.
PageEvents
Screen View
Emits when a $screen event is captured in PostHog, indicating a screen was viewed in a mobile app.
ScreensEvents
Autocapture
Emits when an auto-captured interaction such as a click, form submission, or input change occurs.
InteractionsEvents
User Identified
Emits when an anonymous visitor is identified against a known distinct ID in PostHog.
UsersEvents
Person Properties Set
Emits when person properties are set or updated on a PostHog person profile.
UsersEvents
Group Identified
Emits when a group is created or its properties are updated in PostHog.
GroupsEvents
Feature Flag Evaluated
Emits when a feature flag is evaluated for a user in PostHog.
Feature FlagsEvents
Exception Captured
Emits when an error or exception is captured by PostHog error tracking.
ErrorsEvents
Custom
Emits when any custom (non-system) event is captured in PostHog. The original event name is preserved in the payload.
Events