PostHog Integration — ModuleX AI

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
• EU cloud: https://eu.posthog.com
• Self-hosted: 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`

get_dashboards — List dashboards with optional search / pinned filter

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

pinned

boolean

Filter by pinned status

Response

{
  "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"
}

get_dashboard — Get a specific dashboard

Parameters

project_id

integer

required

PostHog project ID

dashboard_id

integer

required

dashboard_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_dashboard — Create a new dashboard

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Dashboard name

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Dashboard description

pinned

boolean

Pin the dashboard

tags

array

Tag list

Response

{
  "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"
}

update_dashboard — Update a dashboard's name, description, pin, or tags

Parameters

project_id

integer

required

PostHog project ID

dashboard_id

integer

required

Dashboard ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

pinned

boolean

Pin status

tags

array

Tag list

Response

{
  "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"
}

delete_dashboard — Delete a dashboard

Parameters

project_id

integer

required

PostHog project ID

dashboard_id

integer

required

dashboard_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_experiments — List experiments

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_experiment — Get an experiment

Parameters

project_id

integer

required

PostHog project ID

experiment_id

integer

required

experiment_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_experiment — Create an A/B test experiment

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Experiment name

feature_flag_key

string

required

Feature flag key linked to the experiment

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Experiment description

experiment_type

string

‘product’ or ‘web’ (Default: product)

primary_metrics

array

Primary metric definitions

secondary_metrics

array

Secondary metric definitions

variants

array

Experiment variants

minimum_detectable_effect

number

Minimum detectable effect % (Default: 30)

filter_test_accounts

boolean

Filter out internal/test accounts (Default: true)

Response

{
  "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"
}

update_experiment — Update an experiment (rename, change metrics, launch, conclude, or archive)

Parameters

project_id

integer

required

PostHog project ID

experiment_id

integer

required

Experiment ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

primary_metrics

array

Primary metrics

secondary_metrics

array

Secondary metrics

launch

boolean

Launch the experiment

conclude

string

‘won’ / ‘lost’ / ‘inconclusive’

Response

{
  "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"
}

delete_experiment — Delete an experiment

Parameters

project_id

integer

required

PostHog project ID

experiment_id

integer

required

experiment_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_experiment_results — Get experiment results (optionally force refresh)

Parameters

project_id

integer

required

PostHog project ID

experiment_id

integer

required

Experiment ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

refresh

boolean

Force refresh (Default: false)

Response

{
  "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"
}

get_feature_flags — List feature flags

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_feature_flag — Get a flag definition. EITHER flag_id OR flag_key must be provided — pass only one. If both are given, flag_id is used.

Parameters

project_id

integer

required

PostHog project ID

flag_id

integer

Feature flag ID (integer). Mutually exclusive with flag_key — provide one or the other.

flag_key

string

Feature flag key (string). Mutually exclusive with flag_id — provide one or the other.

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_feature_flag — Create a feature flag

Parameters

project_id

integer

required

PostHog project ID

key

string

required

Flag key

name

string

required

Flag name

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Description

filters

object

Flag filters

active

boolean

Active (Default: true)

tags

array

Tag list

Response

{
  "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"
}

update_feature_flag — Update a feature flag (addressed by key)

Parameters

project_id

integer

required

PostHog project ID

flag_key

string

required

Flag key to update

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

filters

object

Updated filters

active

boolean

Active state

tags

array

Tag list

Response

{
  "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"
}

delete_feature_flag — Delete a feature flag

Parameters

project_id

integer

required

PostHog project ID

flag_id

integer

required

flag_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_insights — List insights

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

Response

{
  "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"
}

get_insight — Get an insight

Parameters

project_id

integer

required

PostHog project ID

insight_id

integer

required

insight_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_insight — Create an insight

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Insight name

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Description

filters

object

Insight filter config

query

object

HogQL/JSON query

dashboards

array

Dashboard IDs to attach

tags

array

Tag list

Response

{
  "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"
}

update_insight — Update an insight

Parameters

project_id

integer

required

PostHog project ID

insight_id

integer

required

Insight ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

filters

object

Filter config

query

object

Query

tags

array

Tag list

Response

{
  "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"
}

delete_insight — Delete an insight

Parameters

project_id

integer

required

PostHog project ID

insight_id

integer

required

insight_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

run_query — Run an ad-hoc HogQL/JSON query

Parameters

project_id

integer

required

PostHog project ID

query

object

required

Query body

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

list_error_tracking_issues — List error tracking issues

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

status

string

Filter by status

Response

{
  "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"
}

get_error_tracking_issue — Get an error tracking issue

Parameters

project_id

integer

required

PostHog project ID

issue_id

string

required

issue_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_surveys — List surveys

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

Response

{
  "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"
}

get_survey — Get a survey

Parameters

project_id

integer

required

PostHog project ID

survey_id

string

required

survey_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_survey — Create a survey

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Survey name

type

string

‘popover’ / ‘widget’ / ‘api’ (Default: popover)

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Description

questions

array

Survey questions

conditions

object

Trigger conditions

linked_flag_id

integer

Linked feature flag ID

targeting_flag_filters

object

Targeting filters

appearance

object

Survey appearance config

start_date

string

Start date

end_date

string

End date

Response

{
  "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"
}

update_survey — Update a survey

Parameters

project_id

integer

required

PostHog project ID

survey_id

string

required

Survey ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

questions

array

Questions

conditions

object

Trigger conditions

archived

boolean

Archive the survey

start_date

string

Start date

end_date

string

End date

Response

{
  "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"
}

delete_survey — Delete a survey

Parameters

project_id

integer

required

PostHog project ID

survey_id

string

required

survey_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_organizations — List organizations the user belongs to

Parameters

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_projects — List projects in an organization

Parameters

organization_id

string

Organization ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_event_definitions — List event definitions

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

Response

{
  "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"
}

get_property_definitions — List property definitions

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

event_names

array

Filter by event names

type

string

Filter by property type

Response

{
  "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"
}

capture_event — Capture a single event (ingest API)

Parameters

project_api_key

string

required

PostHog project API key

distinct_id

string

required

Distinct user ID

event

string

required

Event name

properties

object

Event properties

timestamp

string

ISO 8601 timestamp

ingest_url

string

PostHog ingest URL (default: https://us.i.posthog.com)

Response

{
  "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"
}

batch_capture_events — Capture multiple events in one batch request

Parameters

project_api_key

string

required

PostHog project API key

events

array

required

List of event objects

historical_migration

boolean

Flag historical imports (Default: false)

ingest_url

string

PostHog ingest URL (default: https://us.i.posthog.com)

Response

{
  "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"
}

identify_user — Set / update properties on a person via $identify event

Parameters

project_api_key

string

required

PostHog project API key

distinct_id

string

required

Distinct user ID

properties

object

required

Properties to set

ingest_url

string

PostHog ingest URL (default: https://us.i.posthog.com)

Response

{
  "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"
}

alias_user — Create an alias between two distinct IDs (merge users)

Parameters

project_api_key

string

required

PostHog project API key

distinct_id

string

required

Canonical distinct ID

alias

string

required

Alias distinct ID to merge in

ingest_url

string

PostHog ingest URL (default: https://us.i.posthog.com)

Response

{
  "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"
}

evaluate_feature_flags — Evaluate all feature flags for a user (server-side flag evaluation via /flags?v=2)

Parameters

project_api_key

string

required

PostHog project API key

distinct_id

string

required

Distinct user ID

groups

object

Group memberships

person_properties

object

Person properties

group_properties

object

Group properties

ingest_url

string

PostHog ingest URL (default: https://us.i.posthog.com)

Response

{
  "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"
}

group_identify — Identify a group (B2B analytics — org/company/etc.)

Parameters

project_api_key

string

required

PostHog project API key

group_type

string

required

Group type (e.g. ‘company’)

group_key

string

required

Group key (the unique ID)

properties

object

required

Properties to set on the group

ingest_url

string

PostHog ingest URL (default: https://us.i.posthog.com)

Response

{
  "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"
}

get_persons — List persons

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

distinct_id

string

Filter by distinct ID

string

Filter by email

Response

{
  "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"
}

get_person — Get a person by ID

Parameters

project_id

integer

required

PostHog project ID

person_id

string

required

person_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

update_person — Update person properties (PATCH)

Parameters

project_id

integer

required

PostHog project ID

person_id

integer

required

Person ID

properties

object

required

Properties to set

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

delete_person — Delete a person (optionally with associated events)

Parameters

project_id

integer

required

PostHog project ID

person_id

integer

required

Person ID

delete_events

boolean

Also delete events (GDPR) (Default: false)

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

bulk_delete_persons — Delete multiple persons in one call

Parameters

project_id

integer

required

PostHog project ID

person_ids

array

required

Person IDs to delete

delete_events

boolean

Also delete events (Default: false)

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_groups — List groups of a specific group type

Parameters

project_id

integer

required

PostHog project ID

group_type_index

integer

required

Group type index (0-4)

base_url

string

PostHog instance URL (default: https://app.posthog.com)

string

Search query

Response

{
  "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"
}

find_group — Find a specific group by type + key

Parameters

project_id

integer

required

PostHog project ID

group_type_index

integer

required

Group type index

group_key

string

required

Group key

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_group_types — List configured group types for the project

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_cohorts — List cohorts

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_cohort — Get a cohort

Parameters

project_id

integer

required

PostHog project ID

cohort_id

integer

required

cohort_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_cohort — Create a static or dynamic cohort

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Cohort name

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Description

is_static

boolean

Static cohort (Default: false)

filters

object

Filter config

groups

array

Group filters

Response

{
  "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"
}

update_cohort — Update a cohort

Parameters

project_id

integer

required

PostHog project ID

cohort_id

integer

required

Cohort ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

filters

object

Filters

groups

array

Groups

Response

{
  "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"
}

delete_cohort — Soft-delete a cohort

Parameters

project_id

integer

required

PostHog project ID

cohort_id

integer

required

cohort_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_cohort_persons — List persons in a cohort

Parameters

project_id

integer

required

PostHog project ID

cohort_id

integer

required

Cohort ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

Response

{
  "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"
}

get_session_recordings — List session recordings (metadata only)

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

Response

{
  "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"
}

get_session_recording — Get one session recording

Parameters

project_id

integer

required

PostHog project ID

recording_id

string

required

recording_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

delete_session_recording — Delete a session recording

Parameters

project_id

integer

required

PostHog project ID

recording_id

string

required

recording_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_actions — List actions

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

Response

{
  "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"
}

get_action — Get an action

Parameters

project_id

integer

required

PostHog project ID

action_id

integer

required

action_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_action — Create an action (composite event)

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Action name

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Description

steps

array

Action steps (conditions)

tags

array

Tag list

Response

{
  "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"
}

update_action — Update an action

Parameters

project_id

integer

required

PostHog project ID

action_id

integer

required

Action ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

steps

array

Steps

tags

array

Tag list

Response

{
  "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"
}

delete_action — Delete an action (tries soft-delete, falls back to rename if PostHog's soft-delete fails — legacy bug workaround)

Parameters

project_id

integer

required

PostHog project ID

action_id

integer

required

Action ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

delete_action_by_name — Search + delete an action by name (DELETE → soft-delete → rename fallback chain)

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Action name to find + delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_annotations — List annotations

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

string

Search query

Response

{
  "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"
}

get_annotation — Get an annotation

Parameters

project_id

integer

required

PostHog project ID

annotation_id

integer

required

annotation_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_annotation — Create an annotation (a note at a point in time)

Parameters

project_id

integer

required

PostHog project ID

content

string

required

Annotation text

date_marker

string

required

Date marker (ISO 8601)

base_url

string

PostHog instance URL (default: https://app.posthog.com)

dashboard_item

integer

Linked insight (dashboard item)

scope

string

‘dashboard_item’ / ‘project’ / ‘organization’ (Default: organization)

Response

{
  "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"
}

update_annotation — Update an annotation

Parameters

project_id

integer

required

PostHog project ID

annotation_id

integer

required

Annotation ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

content

string

New content

date_marker

string

New date marker

scope

string

New scope

Response

{
  "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"
}

delete_annotation — Delete an annotation

Parameters

project_id

integer

required

PostHog project ID

annotation_id

integer

required

annotation_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_alerts — List alerts

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

insight_id

integer

Filter by insight ID

Response

{
  "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"
}

get_alert — Get an alert

Parameters

project_id

integer

required

PostHog project ID

alert_id

string

required

alert_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_alert — Create an alert on an insight

Parameters

project_id

integer

required

PostHog project ID

insight_id

integer

required

Insight ID

name

string

required

Alert name

base_url

string

PostHog instance URL (default: https://app.posthog.com)

threshold

object

Threshold config

subscribed_users

array

User IDs to notify

enabled

boolean

Enabled (Default: true)

notification_targets

object

Notification target config

Response

{
  "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"
}

update_alert — Update an alert

Parameters

project_id

integer

required

PostHog project ID

alert_id

string

required

Alert ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

threshold

object

Threshold config

subscribed_users

array

User IDs

enabled

boolean

Enabled state

notification_targets

object

Notification targets

Response

{
  "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"
}

delete_alert — Delete an alert

Parameters

project_id

integer

required

PostHog project ID

alert_id

string

required

alert_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

get_early_access_features — List early-access features

Parameters

project_id

integer

required

PostHog project ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

limit

integer

Max results (Default: 100)

offset

integer

Results to skip (Default: 0)

Response

{
  "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"
}

get_early_access_feature — Get an early-access feature

Parameters

project_id

integer

required

PostHog project ID

feature_id

string

required

feature_id to retrieve

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

create_early_access_feature — Create an early-access feature

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Feature name

base_url

string

PostHog instance URL (default: https://app.posthog.com)

description

string

Description

stage

string

draft / beta / general-availability / archived (Default: beta)

documentation_url

string

Documentation URL

feature_flag_id

integer

Linked feature flag ID

Response

{
  "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"
}

update_early_access_feature — Update an early-access feature

Parameters

project_id

integer

required

PostHog project ID

feature_id

string

required

Feature ID

base_url

string

PostHog instance URL (default: https://app.posthog.com)

name

string

New name

description

string

New description

stage

string

Updated stage

documentation_url

string

Updated documentation URL

Response

{
  "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"
}

delete_early_access_feature — Delete an early-access feature

Parameters

project_id

integer

required

PostHog project ID

feature_id

string

required

feature_id to delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

delete_early_access_feature_by_name — Search + delete an early-access feature by name

Parameters

project_id

integer

required

PostHog project ID

name

string

required

Feature name to find + delete

base_url

string

PostHog instance URL (default: https://app.posthog.com)

Response

{
  "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"
}

​Overview

​Authentication

​PostHog API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

Overview

Authentication

PostHog API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters