> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# PostHog Integration for AI Agents & Workflows
> Product analytics platform: events, persons, groups, cohorts, dashboards, insights, experiments, feature flags, surveys, session recordings, error tracking, and more (78 actions).
{/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */}
## Overview
Add **PostHog** to any ModuleX agent or workflow. Product analytics platform integration via the PostHog REST + ingest APIs. Pure HTTP. **78 actions** — the largest single integration in the package.
**Categories**: Analytics & Data · Data & Analytics · Data · Development · **Auth**: PostHog API Key · **Actions**: 78
## Authentication
### PostHog API Key Authentication
Connect to PostHog using your personal API key, project ID, and instance URL.
#### Required Credentials
| Field | Description | Required | Format |
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -------------------------------------- |
| Personal API Key | Your PostHog personal API key | Yes | `phx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` |
| Project ID | PostHog project ID (found in project settings) | Yes | `12345` |
| Instance URL | Your PostHog instance URL — required. MUST be ONLY the host with scheme, no trailing slash, no path. Pick the line that matches your workspace: | | |
| • US cloud: [https://us.posthog.com](https://us.posthog.com) | | | |
| • EU cloud: [https://eu.posthog.com](https://eu.posthog.com) | | | |
| • Self-hosted: [https://posthog.your-company.com](https://posthog.your-company.com) | | | |
| DO NOT append /api, /api/projects, or any other path — the rest of the URL is added automatically. Trailing slash also not allowed. | Yes | `https://us.posthog.com` | |
## Available Actions
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
Filter by pinned status
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
dashboard\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Dashboard name
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Dashboard description
Pin the dashboard
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Dashboard ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Pin status
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
dashboard\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
experiment\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Experiment name
Feature flag key linked to the experiment
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Experiment description
'product' or 'web' (Default: `product`)
Primary metric definitions
Secondary metric definitions
Experiment variants
Minimum detectable effect % (Default: `30`)
Filter out internal/test accounts (Default: `true`)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Experiment ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Primary metrics
Secondary metrics
Launch the experiment
'won' / 'lost' / 'inconclusive'
Archive the experiment
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
experiment\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Experiment ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Force refresh (Default: `false`)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Feature flag ID (integer). Mutually exclusive with flag\_key — provide one or the other.
Feature flag key (string). Mutually exclusive with flag\_id — provide one or the other.
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Flag key
Flag name
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Description
Flag filters
Active (Default: `true`)
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Flag key to update
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Updated filters
Active state
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
flag\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
insight\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Insight name
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Description
Insight filter config
HogQL/JSON query
Dashboard IDs to attach
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Insight ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Filter config
Query
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
insight\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Query body
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
Filter by status
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
issue\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
survey\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Survey name
'popover' / 'widget' / 'api' (Default: `popover`)
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Description
Survey questions
Trigger conditions
Linked feature flag ID
Targeting filters
Survey appearance config
Start date
End date
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Survey ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Questions
Trigger conditions
Archive the survey
Start date
End date
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
survey\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
Organization ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
Filter by event names
Filter by property type
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project API key
Distinct user ID
Event name
Event properties
ISO 8601 timestamp
PostHog ingest URL (default: [https://us.i.posthog.com](https://us.i.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project API key
List of event objects
Flag historical imports (Default: `false`)
PostHog ingest URL (default: [https://us.i.posthog.com](https://us.i.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project API key
Distinct user ID
Properties to set
PostHog ingest URL (default: [https://us.i.posthog.com](https://us.i.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project API key
Canonical distinct ID
Alias distinct ID to merge in
PostHog ingest URL (default: [https://us.i.posthog.com](https://us.i.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project API key
Distinct user ID
Group memberships
Person properties
Group properties
PostHog ingest URL (default: [https://us.i.posthog.com](https://us.i.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project API key
Group type (e.g. 'company')
Group key (the unique ID)
Properties to set on the group
PostHog ingest URL (default: [https://us.i.posthog.com](https://us.i.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
Filter by distinct ID
Filter by email
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
person\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Person ID
Properties to set
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Person ID
Also delete events (GDPR) (Default: `false`)
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Person IDs to delete
Also delete events (Default: `false`)
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Group type index (0-4)
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Search query
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Group type index
Group key
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
cohort\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Cohort name
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Description
Static cohort (Default: `false`)
Filter config
Group filters
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Cohort ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Filters
Groups
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
cohort\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Cohort ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
recording\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
recording\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
action\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Action name
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Description
Action steps (conditions)
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Action ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Steps
Tag list
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Action ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Action name to find + delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Search query
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
annotation\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Annotation text
Date marker (ISO 8601)
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Linked insight (dashboard item)
'dashboard\_item' / 'project' / 'organization' (Default: `organization`)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Annotation ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New content
New date marker
New scope
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
annotation\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
Filter by insight ID
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
alert\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Insight ID
Alert name
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Threshold config
User IDs to notify
Enabled (Default: `true`)
Notification target config
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Alert ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
Threshold config
User IDs
Enabled state
Notification targets
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
alert\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Max results (Default: `100`)
Results to skip (Default: `0`)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
feature\_id to retrieve
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Feature name
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
Description
draft / beta / general-availability / archived (Default: `beta`)
Documentation URL
Linked feature flag ID
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Feature ID
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
New name
New description
Updated stage
Updated documentation URL
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
feature\_id to delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
### Parameters
PostHog project ID
Feature name to find + delete
PostHog instance URL (default: [https://app.posthog.com](https://app.posthog.com))
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"result": {
"default": null,
"title": "Result"
}
},
"required": [
"success"
],
"title": "PostHogResult",
"type": "object"
}
```
## Related integrations
## Links
* [PostHog](https://posthog.com)