Posthog

Projects for the current organization.

Retrieve a list of group types within a specific project by providing the project id. this endpoint requires authentication with a personalapikey and grants read access to group data.

Add collaborators to a specific project dashboard. requires 'project id' and 'dashboard id'. supports json, form-urlencoded, and multipart data. returns added collaborator details. auth: 'personalapikeyauth'.

Add a member to an organization role by submitting their details and uuid in json/form, using organization and role ids. requires personalapikeyauth. success gives a 201 status.

Add members with specific roles to a project by providing their user uuid and level (member or admin). requires project id in the url. supports json, form-data, and form-urlencoded input. returns the newly created membership data upon success.

Set up role-based access for a feature flag using `project id` and `feature flag id`. submit access info in json or form format, with `feature flag:write` rights. success returns new details with a 201 code.

Create a bookmark for an activity notification in a project's activity log. requires a `project id` and json payload with activity details. supports verification status, impersonation flags, and system activity distinction.

Post /api/organizations/{organization id}/invites/bulk/: bulk-create organization invites with customizable levels, sender details, and validation checks. supports email automation and private project access settings.

The "/api/projects/{project id}/insights/cancel/" endpoint allows users to cancel insights for a project by providing a project id and insight details in json or csv, and confirms cancellation in the response.

Get the newest updates and plugin info for a pipeline destination by organization and destination id via get request to /api/.../{id}/check for updates.

Retrieve the latest update information for a specific pipeline import app by its id within an organization. this endpoint returns details such as plugin type, name, description, and version data. requires 'id' and 'organization id' as path parameters.

Get update status for a specific pipeline transformation plugin by its unique id within an organization. this endpoint requires the 'organization id' and 'plugin' ids and returns details like plugin type, name, and update information.

Projects for the current organization.

This endpoint duplicates a specified cohort as a static one within a project. path parameters include `project id` (string) and cohort `id` (integer). successful requests return cohort details.

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

Create a new dashboard for a specified project from a template. accepts project id in the path and a json payload with various dashboard object parameters. returns a dashboard instance on success.

Create a domain for a specific organization by post to `/api/organizations/{id}/domains` with json/form data. requires domain, saml setup, and write permissions. returns new domain data with status 201.

Create a new exposure cohort for an experiment in a project by sending a post request with experiment details and feature flag data. requires experiment id and project id in the path.

Manage feature flags by creating, reading, updating, and deleting them using posthog's javascript library or api endpoint. details in the provided documentation.

Manage feature flags by creating, reading, updating, and deleting them. utilize javascript library or endpoint for user-specific flag status. refer to documentation for details.

Create a config for pipeline frontend apps within a specified project. requires project id and payload with object properties such as plugin, enabled status, order, etc. returns newly created config details.

This endpoint handles reading and deleting persons. for creation or updates, use the capture api, `$set` or `$unset` properties, or sdks.

Post /api/organizations/ - create a new organization with details like name, membership level, and features access. requires organization:write permission. returns organization info on success.

Create a new experiment in a specific project using json, form, or multipart data. requires project id and experiment details, secured with personalapikeyauth. generates a 201 response with experiment info.

Send invites with roles (member, admin, owner) via email to join an organization by id. use json, form data, or multipart with a personal api key for security. successful invites return a 201 status.

Create a new role for the specified organization by supplying role details. requires organization id (uuid) and role data in json. returns the created role on success with a 201 status code. security: personalapikeyauth.

Create a proxy record for an org by sending org id in url and json/form/multipart data with domain, target cname, and status. requires personalapikeyauth and org write access; returns record details.

This endpoint is for reading and deleting persons. use the capture api, `$set`/`$unset` properties, or sdks to create or update them.

This api endpoint is for reading and deleting users. use the capture api, `$set`/`$unset` properties, or sdks for creating/updating users.

Create pipeline destination configurations for a specific project by submitting plugin and order details, among other configuration info, with required project id. authentication needed. responds with 201 on success.

Create a job for a pipeline destination config with a specific id within the specified project. requires project id & config id in the path, and a json payload with plugin and order info.

A job imports app settings into a project pipeline using project id and plugin config id, accepting json/form/multipart, and specifies plugin details, enabling status, and order for pipeline import apps configs.

Create a job-related configuration for a specific plugin by providing plugin and project ids. accepts json, form data, and returns config details on success. use carefully; requires mandatory fields.

This post endpoint creates actions for a project, accepts various data types, requires project id and action data, optionally outputs in csv/json, and needs personalapikeyauth, returning a 201 with action details.

Create cohorts for a specified project by posting json-form data to "/api/projects/{project id}/cohorts/". provide project id in url and the necessary payload, adhering to json schema constraints. authentication required. returns 201 upon success.

The post endpoint creates a dashboard within a project using a `project id`, accepting details in json/form formats. it uses 'personalapikeyauth' for security and returns http 201 with dashboard details on success.

The post endpoint enables creating insights for projects using a project id and supports json/csv. it offers detailed parameters for customizing insights and returns structured data with personalapikeyauth for security.

Create project insights with optional csv/json format parameter. requires `project id` in the path and a json body with project insight details. supports personal api key authentication. successful requests return a 201 status code with insight data.

Create pipeline app configurations for a specified project via post, requiring a project id and json, form, or multipart payload. supports configs, plugins, and app details. returns 201 on success. auth required.

Create a job for a pipeline frontend app config in a project. requires `project id` and config `id`, accepting json/form-data. returns the created job's details.

Create a pipeline transformation config within a specific project by posting json, form, or multipart data. include plugin id, order, and enabled status. ensure project id is in the path. authentication required.

Create a new plugin configuration for a specified project by post to /api/projects/{project id}/plugin configs/. requires project id and json payload with plugin details; must authenticate with personalapikeyauth.

Create a subscription for a given project by providing required details such as delivery method, frequency, and starting date. requires a project id and supports various content types. returns the newly created subscription. security: personalapikeyauth.

Create surveys in a project by providing a project id and details like type, questions, and targets in json, form-data, or urlencoded format. use personalapikeyauth for security. get a survey object on success.

Create timing insights for a project by post to /api/projects/{project id}/insights/timing, supporting csv or json. it returns a 200 status with content in the chosen format.

The `/api/projects/{project id}/query/` post endpoint allows users to submit queries for a specific project by providing the project id in the url and the query details in json or form data. authentication is required and it returns query results.

Create and retrieve retention insights for a project using its id, allowing csv/json outputs. requires an api key with `insight:read` permissions and supports query node json strings and old dashboard ids.

The post endpoint generates a project's session recording, needing 'project id', 'short id', and 'session recording id' in the url, and accepts various content formats for recording details.

Create playlists of session recordings for a specified project. requires 'project id' path parameter and personal api key with write access. supports json, form-encoded, or multipart data. returns 201 on success with playlist details.

Summarize a session recording by providing the project id and the recording's uuid. get details like duration, activities, and user info.

Manage feature flags for apps with create, read, update, and delete operations using posthog's javascript library or dedicated endpoint. more info in the docs.

Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

Delete an organization by its uuid. requires a 'personalapikeyauth' with 'organization:write' permission. on success, returns a 204 status code with no response body.

Projects for the current organization.

This endpoint is used to read and delete user data. use the capture api, `$set`/`$unset` commands, or sdks for creating/updating persons.

Delete a session recording by providing the session's uuid and the associated project id. requires `session recording:write` permission. returns no content on successful deletion.

Delete a survey by providing its uuid and the associated project id. requires 'survey:write' permission. returns no content with a 204 status on success.

Enables a new early access feature for a project using project id, payload with details, and personalapikeyauth. returns a 201 status on success.

Retrieve logs for a specific batch export within a project by its uuid. endpoint requires project id and export id (uuid). supports json responses detailing export properties, run statuses, and error info.

Retrieve pipeline transformation export unsubscribe configurations for a specified organization by its uuid. returns details including id, plugin type, and configuration schema in json format.

Retrieve activity details for a specific pipeline frontend app config by id within a project. requires both `project id` and config `id` in the path. returns json with app config details like plugin info, enablement, order, and error status.

Retrieve organization details by uuid. endpoint requires 'organization:read' access. response includes name, slug, timestamps, membership, plugins access level, and team structure.

Retrieve details of pipeline import app repositories for a specific organization by its uuid. returns json with properties like plugin type, name, and url. supports 'local', 'custom', 'repository', 'source', 'inline' types.

Use a get request to '/api/projects/{project id}/pipeline destination configs/{id}/activity/' to get details, status, config, and metrics for a pipeline destination by id, returning json.

Retrieve details of pipeline transformations from a specified organization's repository. requires `organization id` (uuid). returns json with properties like id, plugin type, and name. supports filtering by types like local, custom, repository, etc.

Fetch secondary experiment data in a project by its unique id, using project and experiment ids as path parameters. authenticated by personalapikeyauth, it returns a json with experiment info, features, and metrics.

Retrieve the activity log of surveys within a specific project by using the project id. this endpoint requires a personalapikeyauth with 'activity log:read' permission and returns survey details including types, flags, questions, and metadata.

Retrieve session recording playlist details for a specific project by project id and playlist short id. requires personalapikeyauth with read access. returns playlist metadata including creation and modification info.

Hard delete of this model is not allowed. use a patch api call to set "deleted" to true

The /api/projects/{project id}/insights/funnel/correlation endpoint generates a correlation insight for funnel analysis in a project, accepting json/csv and needing 'project id' and insight details.