Beyond-Bot.ai + posthog

PostHog is an open-source product analytics platform tracking user interactions and behaviors to help teams refine features, improve funnels, and reduce churn

What You Can Do with this Integration

Automate Data Entry

Automatically sync new contacts or deals from Beyond-Bot.ai to posthog.

Enrich Customer Profiles

Use Beyond-Bot.ai to find and add new information to your records in posthog.

Trigger Workflows

Start automated workflows in posthog based on conversations with your virtual expert.

Available Actions

Here are the specific actions your virtual expert can perform within posthog.

Posthog List Projects In Organization With Pagination

Projects for the current organization.

Posthog List Project Group Types By Id

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.

Posthog Add Dashboard Collaborators With Access Level

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'.

Posthog Add Member To Organization Role

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.

Posthog Add Project Specific Member Roles

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.

Posthog Assign Feature Flag Role Based Access

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.

Posthog Bookmark Project Activity Notification

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.

Posthog Bulk Create Organization Invites

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.

Posthog Cancel Insights For A Project

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.

Posthog Check Pipeline Destination Updates

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.

Posthog Check Pipeline Import App 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.

Posthog Check Pipeline Plugin Update Status

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.

Posthog Check Project S Demo Data Generation Status

Projects for the current organization.

Posthog Cohort Duplication To Static

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.

Posthog Create A Notebook In A Project

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

Posthog Create Dashboard From Template In Project

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.

Posthog Create Domain With Saml For Organization

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.

Posthog Create Experiment Exposure Cohort

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.

Posthog Create Feature Flags For Project

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

Posthog Create Feature Flag Dashboard

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.

Posthog Create Frontend App Pipeline Config

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.

Posthog Create Funnel Analysis For Project Persons

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

Posthog Create New Organization With Configurable Access

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.

Posthog Create New Project Experiment

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.

Posthog Create Organization Invite With Role And Email

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.

Posthog Create Organization Role With Feature Flag Levels

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.

Posthog Create Org Proxy Record With Domain And Status

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.

Posthog Create Person Funnel Correlation

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

Posthog Create Person Path With Format Option

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

Posthog Create Pipeline Destination Config

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.

Posthog Create Pipeline Destination Config Job

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.

Posthog Create Pipeline Import Apps Config Job

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.

Posthog Create Plugin Job Configuration

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.

Posthog Create Project Action With Format

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.

Posthog Create Project Cohorts

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.

Posthog Create Project Dashboard

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.

Posthog Create Project Insights With Customizable Parameters

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.

Posthog Create Project Insights With Format Option

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.

Posthog Create Project Pipeline App Configs

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.

Posthog Create Project Pipeline Frontend App Job

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.

Posthog Create Project Pipeline Transformation Config

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.

Posthog Create Project Plugin Configuration

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.

Posthog Create Project Subscription With Delivery Options

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.

Posthog Create Project Surveys With Questions And Targets

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.

Posthog Create Project Timing Insights

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.

Posthog Create Query In Project By Id

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.

Posthog Create Retrieve Retention Insights For Project

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.

Posthog Create Session Recording In Playlist

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.

Posthog Create Session Recording Playlists

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.

Posthog Create Session Recording Summary

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

Posthog Create Static Cohort For Feature Flag

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.

Posthog Crud Operations For Project Annotations

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

Posthog Delete Organization By Uuid

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

Posthog Delete Organization Project

Projects for the current organization.

Posthog Delete Person And Optionally Associated Events

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

Posthog Delete Session Recording By Uuid

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.

Posthog Delete Survey By Id

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.

Posthog Enable Project Early Access Feature

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

Posthog Fetch Batch Export Details Via Uuid

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.

Posthog Fetch Export Unsubscribe Settings

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.

Posthog Fetch Frontend App Config Status

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.

Posthog Fetch Organization Details By Uuid

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

Posthog Fetch Organization Pipeline App Repositories

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.

Posthog Fetch Pipeline Destination Details

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.

Posthog Fetch Pipeline Transformation Details

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.

Posthog Fetch Project Experiment Secondary Data

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.

Posthog Fetch Project Survey Activity Log

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.

Posthog Fetch Session Recording Playlist Details

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.

Posthog Flag Annotation As Deleted

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

Posthog Generate Project Funnel Correlation Insight

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.

Posthog Initiate Domain Verification With Saml Config

Post /api/organizations/{organization id}/domains/{id}/verify/: initiates verification for a domain within an organization using its uuid, updating its verification status and related saml configuration attributes. supports json and form data formats.

Posthog Initiate Pipeline Transformation Job

Create a pipeline transformation job for a specified plugin config in a project by posting to `/api/projects/{project id}/pipeline transformation configs/{id}/job/`. requires project id and plugin config id.

Posthog List And Filter Project Events

This endpoint for listing/filtering events is deprecated and maintained only for compatibility. users are discouraged from using it and should use the query endpoint for ad-hoc lists/aggregations or cdp/batch exports for bulk exports.

Posthog List And Manage Project Annotations

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

Posthog List And Manage Project Feature Flags

Manage feature flags with creation, reading, updating, and deletion capabilities. utilize javascript library or an endpoint for application integration. more details in the docs.

Posthog List Batch Export Runs

List runs for a batch export by `batch export id` within a project. supports pagination & ordering of the results. requires `batch export:read` permission. returns status, errors, counts, and timestamps for each run.

Posthog List Dashboard Sharing Configs

Retrieve a list of dashboard sharing configurations for a specified project and dashboard. requires dashboard id, project id, and sharing read permission via personalapikeyauth. returns json array of sharing settings.

Posthog List Feature Flag Role Access Details

This get endpoint returns role access details for a feature flag in a project, needs 'project id' & 'feature flag id', and offers optional 'limit' & 'offset' for pagination.

Posthog List Notebooks With Filters And Pagination

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

Posthog List Of Project S Session Recording Playlists

Retrieve a list of session recording playlists for a specific project. filter by creator, paginate with limit and offset, and identify playlists with project id and optional short id. requires 'session recording playlist:read' permission.

Posthog List Organization Domains With Pagination

Fetch a list of an organization's domains with pagination using `limit` and `offset`. access requires `organization id` and a personalapikeyauth. optional parameters available. provides domain info, verification, and saml setup.

Posthog List Organization Invites With Pagination

Retrieve a paginated list of invites for a specific organization, identified by `organization id`, with optional `limit` and `offset` query params for result customization. requires `organization member:read` permission.

Posthog List Organization Members With Pagination

Retrieve members list from an organization with 'limit' and 'offset' options using personalapikeyauth and organization id. access requires organization member:read permission. returns members' details and statuses.

Posthog List Organization Plugins With Pagination

Retrieve the list of plugins for a specified organization. supports pagination through 'limit' and 'offset' query parameters. requires a valid organization uuid and personalapikeyauth for access. returns plugin details including types and status.

Posthog List Organization Roles With Pagination

Fetch a paginated list of roles in an organization using its uuid. supports query parameters for limits and offsets. access needs personalapikeyauth. returns details like id, name, and creator info.

Posthog List Organization S Batch Exports With Pagination

Retrieve paginated batch exports for an organization, with filters and optional limits. includes team, interval, and status details. access requires personalapikeyauth with batch export:read rights.

Posthog List Organization S Paginated Proxy Records

Retrieve a paginated list of an organization's proxy records by id, with 'limit' and 'offset' options. 'organization id' and 'personalapikeyauth' are necessary. includes status, domain, and counts.

Posthog List Organization S Pipeline Destinations

Retrieve a paginated list of an organization's pipeline destinations by id, with optional count and offset parameters. requires personalapikeyauth (plugin:read). returns details like id, type, and organization info.

Posthog List Organization S Pipeline Frontend Apps

Retrieve a paginated list of pipeline apps for an organization using 'plugin:read' personalapikeyauth. requires organization id (uuid) and supports limit and offset parameters. includes app types and statuses.

Posthog List Organization S Pipeline Import Apps

Retrieve a paginated list of pipeline import applications for a specified organization by id. supports optional 'limit' and 'offset' query parameters for result pagination. requires an organization uuid and a personal api key for authentication.

Posthog List Organization S Pipeline Transformations

Retrieve paginated pipeline transformation lists for an organization using `limit` and `offset`, requiring a uuid and personalapikeyauth. supports filtering and detailed views.

Posthog List Or Delete Persons With Optional Filters

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

Posthog List Paginated Surveys For A Project

Get paginated surveys for a project with its id, using 'limit' and 'offset'. needs personalapikeyauth ('survey:read'). json output includes survey info, links, and metadata.

Posthog List Pipeline Destination Configs With Pagination

List pipeline destination configurations for a given project by id, with optional pagination through 'limit' and 'offset' query parameters. returns details such as plugin info and delivery rates. authentication required.

Posthog List Pipeline Frontend App Configs

Retrieve paginated configurations for pipeline frontend apps associated with a specified project. query parameters 'limit' and 'offset' control pagination. requires a project id and personalapikeyauth for access. supports json responses.

Posthog List Project Actions With Pagination And Filters

Get paginated project actions with filters by format. query params: limit, offset. needs personalapikeyauth for read. includes id, name, description, metadata.

Posthog List Project Batch Exports With Pagination

Retrieve an indexed list of batch exports for a specified project with optional pagination. view export details, statuses, and pagination links. requires project id and supports personalapikeyauth.

Posthog List Project Configuration Plugin Logs

Retrieve logs for a specific plugin configuration within a project. supports pagination with limit and offset query parameters. requires project and plugin configuration ids. auth: personalapikeyauth with plugin:read scope.

Posthog List Project Dashboards With Pagination

Get paginated dashboards for a project by id, using 'limit' and 'offset'. must authenticate with personalapikeyauth. includes count, pagination, and dashboard details.

Posthog List Project Dashboard Collaborators

Get dashboard collaborators list in a project using project string id and dashboard integer id. requires personalapikeyauth and `dashboard:read` permission. returns details like access level and timestamps.

Posthog List Project Dashboard Templates

"retrieve a paginated list of dashboard templates for a specified project. use 'limit' and 'offset' query parameters to control result pagination. requires project's id in the path and supports personalapikeyauth for security."

Posthog List Project Early Access Features

Retrieve a paginated list of a project's early access features by id with 'limit' and 'offset' parameters. an api key is needed. includes feature info like creation date, stage, and documentation link.

Posthog List Project Experiments With Pagination

Get a paginated list of experiments within a project using 'limit' and 'offset' parameters. need a valid project id and 'experiment:read' permission. returns details like features and metrics.

Posthog List Project Export Items With Pagination

Retrieve a paginated list of export items for a specific project by id with optional 'limit' and 'offset' query parameters. requires personalapikeyauth for export:read permission. supports multiple export formats.

Posthog List Project Membership Details

Retrieve a list of project membership details for a specified project by id. members and their roles, such as member or admin, are included along with their join and update timestamps.

Posthog List Project Pipeline Configurations

Fetch paginated pipeline configuration list for a project by its id, utilizing optional `limit` and `offset`. endpoint returns json data.

Posthog List Project Pipeline Import Configs

List pipeline import app configurations for a specified project, with pagination options 'limit' and 'offset'. requires a project id and supports personalapikeyauth for security. responds with json objects including configuration details.

Posthog List Project Plugin Configurations

Retrieve a paginated list of plugin configurations for a specific project by project id. supports optional 'limit' & 'offset' query params for result batching. requires 'personalapikeyauth' for 'plugin:read' access.

Posthog List Project Session Recordings

Retrieve a paginated list of session recordings for a specific project, including viewing times and user interactions. specify `project id`, and use optional `limit` and `offset` query parameters to control result set size and starting point.

Posthog List Project Subscriptions With Pagination

Retrieve a paginated list of subscriptions for a given project by its id. optional query params include 'limit' for results per page and 'offset' for results starting index. authentication is required. returns subscription details and navigation links.

Posthog List Role Memberships Paginated

Retrieve a paginated list of role memberships for a specific role within an organization, including membership details. optional query parameters ‘limit’ and ‘offset’ control pagination; ‘organization id’ and ‘role id’ are path parameters.

Posthog List Session Recording Sharing Configs

Retrieve a list of sharing configurations for a specific session recording in a project, including creation timestamps and access tokens. requires project and recording ids.

Posthog List Specific Type Groups With Pagination

List all groups of a specific group type. you must pass ?group type index= in the url. to get a list of valid group types, call /api/:project id/groups types/

Posthog List Unused Organization Pipeline Transformations

Retrieve a list of unused pipeline transformations for a specified organization, identified by uuid. includes details like name, plugin type, and configuration. supports json response format.

Posthog List Users With Staff Filter And Pagination

Api endpoint fetches a user list with staff filter, pagination (limit, offset), and requires a personal api key. data includes uuids, emails, and organizational details.

Posthog Manage Feature Flag Enrichment For Usage Dashboard

Learn to manage feature flags (creation, access, modification, removal) using posthog's docs, with options to use a javascript library or a dedicated endpoint for user-specific flag status.

Posthog Manage Project Feature Flags

Learn to manage feature flags: create, read, update, delete, and check their status using the javascript library or an endpoint. consult the linked docs for details.

Posthog Manage Project Feature Flags For Local Evaluation

Utilize feature flags to manage application features with creation, reading, updating, and deletion. consult posthog's docs or use their js library or endpoint for user-specific flag checks.

Posthog Manage User Feature Flags

Manage feature flags in your app with create, read, update, and delete options. use posthog's javascript library or endpoint to verify user access. see documentation for details.

Posthog Mark Dashboard Template As Deleted

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

Posthog Mark Insight As Viewed With Configurable Format

The post endpoint marks an insight as viewed for a specified project, requires `project id` and `id`, supports `csv` or `json` formats, and returns fast-loading serialized data.

Posthog Mark Project Action As Deleted

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

Posthog Mark Session Recording Playlist Deleted

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

Posthog Mark Subscription As Deleted By Id

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

Posthog Modify Org Info Via Uuid

Put /api/organizations/{id}/: update organization details by providing a uuid as 'id'. supports json, form-urlencoded, multipart/form-data. requires 'organization:write' permission. returns updated organization data.

Posthog Move Dashboard Tile

Endpoint to move a tile within a dashboard by `id`. requires `project id`, accepts json/form-data (e.g., `name`, `pinned`), and returns updated dashboard info.

Posthog Partially Update Project Plugin Config

Update plugin configuration partially for a specified project using patch on '/api/projects/{project id}/plugin configs/{id}'. requires plugin write authority. accepts json, form data, and multipart. returns updated plugin config details.

Posthog Partially Update Project Property Definition

Patch /api/projects/{project id}/property definitions/{id}/: partially update a specific property definition by uuid in a project. requires property definition:write auth. no response body.

Posthog Partial Experiment Update In Project

Endpoint enables partial updates to an experiment in a project using patch, needing `project id`, `experiment id`, and various payload types. returns updated details. authentication is mandatory.

Posthog Partial Pipeline Frontend App Config Update

Patch method to partially update config of a pipeline frontend app for a project by id. requires write permission on plugin. accepts json, form-data; returns updated config details.

Posthog Partial Update Of A Project Insight

The patch endpoint supports partial insight updates in a project, allows format specification (csv/json), and requires `personalapikeyauth` and `insight:write` scope for access.

Posthog Partial Update Of A Project S Dashboard

Endpoint patch /api/projects/{project id}/dashboards/{id}: allows partial update of a project's dashboard with specified id. accepts json, form data, and provides a detailed response schema based on user license. requires dashboard write access.

Posthog Partial Update Of A Project S Feature Flag

Learn to manage feature flags (create, read, update, delete) using posthog's docs, with options for javascript library use or dedicated endpoints for user flag status.

Posthog Partial Update Of Project Notebook

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

Posthog Partial Update Project Annotation

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

Posthog Persist Session Recording Data By Uuid

Post `/api/projects/{project id}/session recordings/{id}/persist`: endpoint for persisting session recording data identified by uuid. requires `project id` and accepts json containing various read-only session metrics. responds with session data.

Posthog Person Partial Update Via Project Id

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

Posthog Person Property Deletion Endpoint

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

Posthog Post Project Trends With Filters

The `/api/projects/{project id}/insights/trend/` endpoint provides project trends in csv/json, requires `project id` and optional parameters, and needs 'personalapikeyauth'. it outputs event data and cache status.

Posthog Prevent Hard Delete Notebook By Flagging

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

Posthog Project Funnel Advanced Analytics

The `/api/projects/{project id}/insights/funnel/` endpoint generates customizable funnel insights for a project in either csv or json, offering filtering, exclusion, and ordering features with cachable results. specify output with the `format` query.

Posthog Rearrange Frontend App Pipeline Configs

Patch /api/projects/{project id}/pipeline frontend apps configs/rearrange/: rearrange the config of frontend apps in a project's pipeline. requires project id in the path and a json object in the request body. responds with updated config details.

Posthog Rearrange Pipeline Transformation Configs

Endpoint `/api/projects/{project id}/pipeline transformation configs/rearrange/` allows for partial updates to the arrangement of pipeline configurations for a given project. accepts patch requests with necessary parameters and the project id in the path.

Posthog Rearrange Project Import App Configurations

Rearrange app import settings in a project using patch /api/projects/{project id}/... by updating plug-in order and status. requires `project id` and a json with configurations.

Posthog Rearrange Project Pipeline Destination Configs

"patch /api/projects/{project id}/pipeline destination configs/rearrange/": adjust order and settings of pipeline destinations for a project by project id. requires json body with plugin, enabled state, etc. returns updated configuration.

Posthog Reconfigure Plugin Order And Status In Project

Patch endpoint to reconfigure the order of plugins within a project by project id. supports json, form, and multipart bodies to update plugin order and status.

Posthog Remove Domain By Uuid From Organization

Delete a specific domain by its uuid within an organization, given valid organization and domain ids. requires 'organization:write' permission; no response body on success (204).

Posthog Remove Early Access Feature From Project

Delete an early access feature by id from a specified project. requires a uuid for the feature and the project's id. authentication via personalapikeyauth is necessary. no response body upon success.

Posthog Remove Explicit Project Member By Uuid

Delete a specific user (by uuid) from the explicit members of a given project. requires 'project id' and member's 'parent membership user uuid'. returns 204 on success with no response body.

Posthog Remove Feature Flag Role Access By Id

Delete /api/projects/{project id}/feature flags/{feature flag id}/role access/{id}: remove role access from a feature flag in a project by id, requiring authorization. expect no response body upon success (204).

Posthog Remove Member From Organization By Uuid

Delete /api/organizations/{org id}/members/{user uuid}: removes a specific member from an organization using uuids for both entities. requires 'organization member:write' permission; returns 204 with no content on success.

Posthog Remove Organization Batch Export By Uuid

Delete a specific batch export by its uuid in an organization. requires personalapikeyauth with batch export:write permission. returns 204 on success with no response body.

Posthog Remove Organization Pipeline Destination

Delete a specific pipeline destination in an organization by id. requires an integer 'id' of the destination, and the organization's 'uuid'. auth: personalapikey with plugin:write. no return body on success (204).

Posthog Remove Organization Pipeline Transformation

Delete a specific pipeline transformation plugin for an organization by id. requires a uuid for the organization and an integer for the plugin. auth: personalapikey with write access. no response body on success (204).

Posthog Remove Organization Plugin By Id

Delete a specific plugin (by its integer id) from the organization (identified by uuid) with no response body on success. requires plugin:write authorization via personalapikeyauth.

Posthog Remove Organization Proxy Record

Delete a proxy record by id for a specific organization. requires an authenticated user with 'organization:write' permission. on success, it responds with a 204 status and no content.

Posthog Remove Organization Role By Id

Delete a role with a specific uuid in an organization. requires 'organization:write' permission. no response body on success (204). path parameters include 'id' and 'organization id'.

Posthog Remove Org Pipeline Import App By Id

Delete a specific pipeline import app plugin associated with an organization by id. requires a personal api key with write permissions for plugins. responds with no content on success (204).

Posthog Remove Pipeline Destination Config

Delete a pipeline destination configuration by specifying a unique integer id within a project. requires 'plugin:write' permission via personalapikeyauth. no response body on success (204). project id is mandatory.

Posthog Remove Pipeline Frontend App By Id

Delete a specific pipeline frontend app by its id within an organization. requires the organization id (uuid) and the app's integer id. auth: personalapikeyauth with plugin:write scope. no response body on success (204).

Posthog Remove Pipeline Frontend App Config

Delete a pipeline frontend app configuration for a specific project. requires 'project id' and config 'id' in the path and 'plugin:write' permissions. responds with 204 on success without a body.

Posthog Remove Pipeline Import App Config

Delete a specific pipeline import app configuration using its id within a project. requires project id and config id, and auth via personalapikeyauth with plugin write access. no response body on success (204).

Posthog Remove Pipeline Transformation Config By Id

Delete a specific pipeline transformation configuration by id within a project. requires the project id and configuration id. secured by personalapikeyauth with plugin:write access. no response body upon success (204).

Posthog Remove Project Dashboard Collaborator

Remove a collaborator from a project dashboard. provide the project id, dashboard id, and user's uuid. requires 'dashboard:write' permissions. expect no response body on success (204). project id guidance at '/api/projects/'.

Posthog Remove Project Event Definition

Delete an event definition by providing its uuid and the associated project id. requires `event definition:write` permission. successful deletion returns no content (204 status).

Posthog Remove Project Experiment By Id

Delete a specific experiment by its unique integer id within a project. requires a project id and personal api key with experiment write permission. no response body upon success.

Posthog Remove Project Plugin Configuration

Delete /api/projects/{project id}/plugin configs/{id}/: removes a specific plugin configuration by id from a given project. requires 'plugin:write' permissions and project id. returns 204 with no body on success.

Posthog Remove Property Definition By Uuid

Delete a property definition by providing its uuid and the associated project id. requires 'property definition:write' permission. on success, no response body is returned (204).

Posthog Remove Role Membership By Uuid

Delete /api/organizations/{org id}/roles/{role id}/role memberships/{id}: removes a role membership from an organization using a specific uuid. requires write access. returns 204 on success.

Posthog Remove Session Recording From Playlist

Delete a session recording from a playlist using its id within a specified project. requires project id, short id, and session recording id in the path. returns no content on success (204).

Posthog Remove Specific Project Batch Export

Delete a specific batch export by providing the uuid and project id. requires a personal api key with 'batch export:write' permissions. responds with no body upon successful deletion (http 204).

Posthog Remove Specific Project Query

(experimental)

Posthog Retrieve And Delete Project Person Trends

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

Posthog Retrieve App Metrics By Ids

Retrieve app-specific metrics for a given project by providing the project id and app metric id. requires a personal api key with plugin:read access. no response body provided upon success (200).

Posthog Retrieve App Metrics Error Details

Retrieves detailed error information for a specific app metric by id within a project. requires project id and metric's integer id as path parameters. no response body for a successful query.

Posthog Retrieve Async Query Status By Id

(experimental)

Posthog Retrieve Batch Export Details

Retrieve details of a specific batch export by its uuid in a project. requires project id and batch export id. supports personalapikeyauth and responds with export details including destination, interval, and status.

Posthog Retrieve Batch Export Logs By Uuid

Retrieve logs for a specific batch export given by uuid within an organization. essential for tracking export status, errors, and configurations. supports json responses detailing export properties and history.

Posthog Retrieve Batch Export Run Logs

Retrieve logs for a specific batch export run within a project. requires `project id`, `batch export id`, and `id` (all uuids). the endpoint returns run status, error info, record count, and timestamps.

Posthog Retrieve Cohort Activity Details

Retrieve activity details for a specific cohort within a project. requires a project id and cohort id, returning status, filters, query, and creator data. auth: personalapikeyauth with 'activity log:read' scope.

Posthog Retrieve Cohort Person Details

Retrieve details of persons within a cohort by its unique id in the specified project. the endpoint supports json and csv formats and requires authorization. project and cohort ids must be provided.

Posthog Retrieve Dashboard Template Details By Uuid

Fetch specific dashboard template details by uuid in a project with 'dashboard template:read' rights using a personalapikeyauth. returns name, description, filters, and creation info.

Posthog Retrieve Dashboard Template Schema

Retrieve the json schema for dashboard templates of a specific project. pass the project id in the path and receive details such as template name, description, filters, and more. supports get requests.

Posthog Retrieve Event Definitions By Project Id

Retrieve definitions for events within a specified project by providing the unique project id. requires personalapikeyauth privileges for event definition:read. no response body provided upon a successful call.

Posthog Retrieve Event Definition By Uuid

Retrieve an event definition by its uuid within a specified project. requires a project id and an event definition id, with access secured by personalapikeyauth. (get /api/projects/{project id}/event definitions/{id})

Posthog Retrieve Experiments Requiring Flag Implementation

Retrieve details for experiments that require feature flag implementation in a specific project. requires a valid 'project id' and user must have 'experiment:read' permission. returns information like experiment names, dates, flags, and creation data.

Posthog Retrieve Experiment Details By Ids

Access detailed experiment info within a project using unique `experiment id` & `project id`, with 'experiment:read' rights. response includes dates, feature flag key, metrics, creator details.

Posthog Retrieve Export Unsubscribe Configs

Retrieve the configuration for unsubscribing from exports in the pipeline import apps for a specific organization. requires an organization uuid in the path. returns various properties including ids, plugin types, and metadata as a json object.

Posthog Retrieve Feature Flags Activity Log

Learn to manage feature flags by creating, reading, updating, and deleting them. use posthog's javascript library or endpoint for application integration. details in the [docs](https://posthog.com/docs/user-guides/feature-flags).

Posthog Retrieve Feature Flags Evaluation Reasons

Manage feature flags—create, read, update, delete—using the posthog javascript library or endpoint for user-specific flag status. (more in docs).

Posthog Retrieve Feature Flag Activity Details

Manage feature flags (creation, reading, updating, and deleting) using posthog's guides or via javascript library/endpoint for user-specific flag status. [details](https://posthog.com/docs/user-guides/feature-flags)

Posthog Retrieve Feature Flag Details

This guide details how to manage (create, read, update, delete) feature flags in applications using posthog's javascript library or endpoint. for more info, visit the provided documentation.

Posthog Retrieve Feature Flag Role Access Details

Retrieve details for a specific role's access to a feature flag within a project. requires 'feature flag id', 'id' for role access, and 'project id'. returns a json object with access details.

Posthog Retrieve Filtered Project Property Definitions

Get property definitions for a project using project id, with filters for event names, property types, exclusions, and numerical or feature flags. also, view properties relevant to specific events.

Posthog Retrieve Funnel Insights In Project

Gain insights from funnel analysis of a specific project by providing its id and having 'insight:read' permission. supports json/csv formats and offers detailed info like creation, modification, and dashboards quickly.

Posthog Retrieve Group Property Definitions By Project Id

Retrieve property definitions for a group within a project by providing the project id. this endpoint returns details like group type index, key, and creation time in json format.

Posthog Retrieve Group Property Values By Index And Key

Retrieve property values by 'group type index' and 'key' within a 'project id'. parameters must be provided. output is a json with property details and creation timestamp.

Posthog Retrieve Hedgehog Configuration By Uuid

Retrieve user's hedgehog configuration details by their uuid. this endpoint requires the user's uuid as a path parameter and returns various user-related settings such as email, team info, timezone, and more in json format. supports get requests.

Posthog Retrieve Historical App Metrics Export

Retrieve historical export data for app metrics by supplying the `project id` and `plugin config id`. requires `plugin:read` permission. no response body provided upon a successful request.

Posthog Retrieve Important Project Activity Log

Retrieve a log of important changes for a specified project. requires a `project id` and returns details about the change, including user info, read status, and timestamps. use `/api/projects/{project id}` to obtain project ids.

Posthog Retrieve Insight Sharing Configurations

Retrieve sharing configurations for a specific insight within a project, requiring project and insight ids. validates access via personalapikeyauth. returns data such as creation time and access tokens.

Posthog Retrieve Last Viewed Insights For User

Returns basic details about the last 5 insights viewed by this user. most recently viewed first.

Posthog Retrieve Matching Events For Session Recording

Retrieves event ids matching a filter with one session id and at least one event/action criterion. intended for internal use and may have sudden changes.

Posthog Retrieve Notebook Activity For Project

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

Posthog Retrieve Notebook Activity Log

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

Posthog Retrieve Notebook Details

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

Posthog Retrieve Organization Pipeline Frontend App Details

Retrieve pipeline frontend app details for an organization using its 'organization id' (uuid). response includes id, plugin type, name, url in json format, covering various plugin types.

Posthog Retrieve Organization Pipeline Unsubscribe Configs

Retrieve unsubscribe config details for an organization's pipeline frontend apps. requires an organization id (uuid). returns json with config data including plugin types and more.

Posthog Retrieve Organization Plugin Activity

Retrieve activity details for plugins in a specified organization by id. supports various plugin types, including local, custom, and repository. response includes plugin's id, name, type, and relevant metrics. requires a valid uuid for 'organization id'.

Posthog Retrieve Organization Plugin Details

Retrieve a specific plugin's details for an organization. requires the plugin's integer id and the organization's uuid. only returns plugin info if authenticated with 'plugin:read' permission. responds with plugin data in json format.

Posthog Retrieve Organization Plugin Repository Details

Retrieve plugin repository details for a specific organization by its uuid, including plugin type, name, url, and more. accessible via get request to '/api/organizations/{organization id}/plugins/repository/'.

Posthog Retrieve Organization Plugin Unsubscribe Configs

Retrieve plugin export unsubscribe configurations for a specified organization by organization id. supports local, custom, repository, source, and inline plugin types, providing details like name, description, url, and icon.

Posthog Retrieve Organization Project Details

Projects for the current organization.

Posthog Retrieve Organization Role Details

Retrieve the details of a specific role within an organization using its uuid. requires the organization's uuid and role's uuid in the path and is protected by personalapikeyauth with 'organization:read' scope. returns role data in json.

Posthog Retrieve Organization S Unused Pipeline Apps

Retrieve unused pipeline import apps for a specified organization. endpoint requires an organization id (uuid) and returns details like plugin type, name, description, and more in json format.

Posthog Retrieve Org Pipeline Repo Details

Retrieve details for repository pipeline destinations within a specific organization by its uuid. returns objects like id, name, and urls with support for various plugin types (local, custom, etc.).

Posthog Retrieve Org Pipeline Transformation Activity

Retrieve pipeline transformation activity details for a specific organization using its uuid. returns data such as plugin type, name, description, and related metrics. requires 'organization id' in url path.

Posthog Retrieve Or Delete Person Retention Data

This endpoint is for reading and deleting person data; use the capture api, `$set`/`$unset` properties, or sdks for creation and updates.

Posthog Retrieve Or Delete Project Persons Funnel Data

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

Posthog Retrieve Paginated Organization List

Retrieve a paginated list of organizations with optional 'limit' and 'offset' query parameters. the response includes organization details like id, name, and membership level, with secure access controlled via personalapikeyauth.

Posthog Retrieve Persons Funnel Correlation Data

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

Posthog Retrieve Person Details By Id

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

Posthog Retrieve Person Details By Project

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

Posthog Retrieve Person Lifecycle Details

This endpoint is for reading and deleting persons. use the capture api, property methods, or sdks for creating or updating persons.

Posthog Retrieve Person Properties Timeline

This endpoint allows reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.

Posthog Retrieve Person S Activity And Delete Options

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

Posthog Retrieve Person Values By Project

This endpoint is for reading and deleting persons. for creation or updates, use the [capture api](https://posthog.com/docs/api/capture), `$set`/`$unset`, or sdks.

Posthog Retrieve Pipeline Destination Activity

Retrieve activity details for pipeline destinations within an organization. required: uuid-formatted `organization id`. outputs application/json with attributes: id, latest tag, etc. supports `get` requests.

Posthog Retrieve Pipeline Destination Config Details

Retrieve details of a specific pipeline destination config for a project by its id. requires project id and destination config id. supports personalapikeyauth for read access. responds with config details including plugin info, status, and timestamps.

Posthog Retrieve Pipeline Destination Details

Fetch a pipeline destination's details by id and organization uuid, using a personalapikeyauth with read access to plugins. returns json with plugin info.

Posthog Retrieve Pipeline Destination Frontend Config

Retrieve configuration details for a specific pipeline destination in a project by getting the frontend data of the config with a given id. this endpoint requires the 'project id' and 'id' of the config.

Posthog Retrieve Pipeline Destination Plugin Details

Retrieve details of a specific pipeline destination plugin within an organization by its unique id. the response includes various properties like name, description, url, and plugin type for the given organization uuid.

Posthog Retrieve Pipeline Frontend App Activity

Retrieve activity details for pipeline front-end apps within a specified organization by organization id. returns json object with app properties such as id, type, name, and configuration. uuid path parameter required.

Posthog Retrieve Pipeline Frontend App Details

Retrieves details of a specified pipeline frontend app within an organization. requires plugin read access and organization id (uuid), and app id (integer) as path parameters. returns json with app information.

Posthog Retrieve Pipeline Frontend App Source Details

Retrieve details for a specific pipeline frontend app's source by its id within an organization. requires an integer id of the app and uuid of the organization. returns json object with app properties.

Posthog Retrieve Pipeline Frontend Plugin Config

Retrieve the frontend configuration for a specific plugin in a project's pipeline. requires project and config ids and returns details like plugin info, status, and creation timestamps.

Posthog Retrieve Pipeline Import Apps Activity

Retrieve activity details of pipeline import apps for a given organization. requires 'organization id' (uuid). returns app id, type, name, url, and other metadata. supports 'local', 'custom', 'repository', 'source', and 'inline' plugin types.

Posthog Retrieve Pipeline Import App Details

Access specific pipeline import app details in an organization using its id and a valid organization uuid. requires 'personalapikeyauth' with 'plugin:read' access. outputs app properties in json format.

Posthog Retrieve Pipeline Import App Source Details

Retrieves source details of a pipeline import app by its id within a specified organization. expects `organization id` (uuid) and `id` (integer) as path parameters. returns app properties including type, name, and related info.

Posthog Retrieve Pipeline Plugin Details By Id

Retrieve pipeline transformation plugin details by id for a specified organization. requires authentication and provides information like plugin type, name, and configuration for authorized users. supports json response.

Posthog Retrieve Pipeline Plugin Source

Retrieve the source details of a pipeline transformation for a specific plugin by id within an organization. access plugin metadata, like its type, url, and config, relevant to organizing and managing pipeline operations.

Posthog Retrieve Pipeline Transformation Activity

Retrieve the activity details of a specific pipeline transformation configuration in a project using its unique integer id. requires project id. returns json including config, plugin info, and activity data.

Posthog Retrieve Pipeline Transformation Config

Retrieve the configuration for a specific pipeline transformation plugin in a project by its id using a get request. requires project id and plugin config id in the path and 'plugin:read' permission.

Posthog Retrieve Pipeline Transformation Frontend Config

Retrieve the frontend configuration details for a specific pipeline transformation by id within a given project. this endpoint requires the project id and transformation config id in the path.

Posthog Retrieve Plugin Config Activity

Retrieve activity details for a specific plugin config within a project's pipeline import apps. requires 'project id' and plugin config 'id' within the api path.

Posthog Retrieve Plugin Config Activity Details

Retrieve activity details for a specific plugin configuration within a project. requires `project id` and unique `id` of the plugin config. responds with plugin info, status, and activity metrics.

Posthog Retrieve Plugin Config Details

Retrieve the configuration details of a specific plugin by its id for a given project. this endpoint requires a project id and plugin config id, with read permission, and returns an object containing config settings and status.

Posthog Retrieve Plugin Config Frontend

Retrieve the frontend configuration of an app's pipeline import by id within a specified project. requires `project id` and `id` of the plugin config. returns json object with config details.

Posthog Retrieve Plugin Frontend Config

Retrieve the frontend configuration of a specific plugin for a given project. requires the project id and plugin config id. provides details including plugin state, order, and related info.

Posthog Retrieve Plugin Source Details

Retrieve plugin source details by organization and plugin id. requires integer 'id' for the plugin and 'organization id' as uuid. responds with plugin attributes including type, name, and url.

Posthog Retrieve Plugin Update Info

This endpoint retrieves update information for a specific plugin within an organization's pipeline frontend app by its integer id and the organization's uuid. it returns details such as plugin type, name, and latest version.

Posthog Retrieve Plugin Update Status

Retrieve the latest update status for a specific plugin, identified by its integer id, within an organization specified by uuid. check compatibility and change logs.

Posthog Retrieve Project Action Details By Id

Get details on a project action by id. supports json/csv format via query. needs 'project id' and 'id' path parameters. secured by personalapikeyauth.

Posthog Retrieve Project Activity Details

Projects for the current organization.

Posthog Retrieve Project Activity Insights

Retrieve activity insights for a specific project by project id, supporting csv or json formats. requires an api key with activity log:read permission. limited to essential data to enhance response time for large datasets.

Posthog Retrieve Project Activity Log With Pagination

Access a project's activity log using pagination and cursor-based navigation. requires project id and personalapikeyauth. outputs activity list with user data and timestamps.

Posthog Retrieve Project Annotation Details

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

Posthog Retrieve Project Cohorts Activity Log

Retrieve activity log for a specific project's cohorts. requires a project id and personalapikeyauth with activity log:read permission. response includes cohort details and creator info.

Posthog Retrieve Project Cohorts With Pagination

Retrieve a paginated list of cohorts for a specific project using `project id`. supports `limit` and `offset` query params to customize the response. requires `personalapikeyauth` with `cohort:read` permissions.

Posthog Retrieve Project Cohort Details

Retrieve detailed information about a specific cohort within a project using its id. requires project id and cohort id; returns cohort details including name, creator info, and status. auth: personalapikeyauth with cohort:read permission.

Posthog Retrieve Project Draft Sql Query

Retrieve the draft sql query for a specific project using its project id. ensure to obtain the project id by calling /api/projects/. note: this endpoint does not return a response body.

Posthog Retrieve Project Early Access Feature Details

Retrieve details of a specific early access feature in a project by id. requires project id and feature uuid. must have 'early access feature:read' permission. returns feature details including status, flag info, and timestamps.

Posthog Retrieve Project Event Details By Id

Retrieve details for a specific event by id within a project. supports csv or json format. requires project id in path and adheres to personalapikeyauth for security.

Posthog Retrieve Project Event Values

Retrieve event values for a specific project by id. supports querying in csv or json format. requires a project id and personal api key with query:read permission. responds with event details such as id, distinct id, properties, etc.

Posthog Retrieve Project Experiment Results

Retrieve experiment results within a project by project and experiment id. requires project id and experiment id in the path. returns experiment details in json, with authentication via personalapikeyauth.

Posthog Retrieve Project Export Details

Retrieve detailed info on a specific export of a project using its unique id. requires project id and supports various export formats like png, pdf, csv, and xlsx. auth: personalapikeyauth with export:read scope.

Posthog Retrieve Project Funnel Correlation Insights

Retrieve insights about funnel correlations for a specific project by id, offering results in json or csv. supports querying and output formatting, with a focus on fast loading of large datasets.

Posthog Retrieve Project Group Details By Key And Type

Retrieves specified group details within a project by group key and type index. requires 'group key', 'group type index', and 'project id'. responds with group details, including creation timestamp.

Posthog Retrieve Project Insights Details

Retrieve detailed insights for a specific project using its id. queries can be made in csv or json format. requires 'insight:read' permission. results include various metadata like creation, last refresh, and associated dashboard info.

Posthog Retrieve Project Insights With Pagination

The get `/api/projects/{project id}/insights/` endpoint retrieves a paginated list of insights for a specified project. filter by creator, response format (csv/json), and use limit/offset for result batching. requires `insight:read` permission.

Posthog Retrieve Project Insight Activity Data

Retrieve insights activity for a specific project and insight id, offering data in json or csv format. requires project id and insight id in the path, with optional data format query. secure access via personalapikeyauth.

Posthog Retrieve Project Insight Details

Retrieve details for a specific project insight by id, with options to format as json/csv, request refresh, and specify dashboard context. supports personalapikeyauth with insight read access. responses include metadata, results, and caching info.

Posthog Retrieve Project Member Details By Uuid

Retrieve detailed information about a specific user's membership level and status within a project by their uuid. access project members' data, roles, and timestamps. (get /api/projects/{project id}/explicit members/{uuid})

Posthog Retrieve Project Person Activity

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

Posthog Retrieve Project Person Cohorts

This endpoint allows reading and deletion of persons; for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks.

Posthog Retrieve Project Person Stickiness

This endpoint allows for reading and deleting persons. for creations or updates, use the capture api, set/unset properties, or sdks.

Posthog Retrieve Project Pipeline Plugin Config

Retrieve configuration details of a specific plugin for a given project pipeline by id. requires a valid project id and plugin config id. supports personalapikeyauth for 'plugin:read' access. responds with json containing configuration data.

Posthog Retrieve Project Session Values

Retrieve session values for a specified project. pass the project id in the url path to obtain the information. only the project's id is required as a parameter. no response body for the 200 ok status code.

Posthog Retrieve Project Subscription Details

Retrieve a specific subscription for a project, identified by 'project id' and 'id'. requires valid api key with read access. supports get method, returns subscription details including frequency, type, and creator info.

Posthog Retrieve Project Trend Insights

Retrieve trend insights for a specific project, supporting csv or json formats. mandatory project id required. provides details on insight cache status, creator, and associated dashboards. auth: personalapikeyauth.

Posthog Retrieve Properties And Events Association

Allows a caller to provide a list of event names and a single property name returns a map of the event names to a boolean representing whether that property has ever been seen with that event name

Posthog Retrieve Property Definition Details

Retrieve details of a specific property definition by uuid within a project. requires project id and property definition id. security: personalapikeyauth with read access. no response body provided.

Posthog Retrieve Proxy Record Details

Retrieve a specific proxy record's details by id within an organization. requires path parameters 'organization id' and 'id'. returns json data including domain, status, and timestamps. auth: personalapikeyauth with 'organization:read'.

Posthog Retrieve Related Project Groups

Retrieve related groups for a specific project and user. requires 'project id' (path), 'group type index', and user 'id' (query). returns group details with type, key, and creation date.

Posthog Retrieve Retention Insights

Retrieve retention insights for a specified project. options to output in csv or json format. requires a project id and supports query customization. authenticated access with 'insight:read' permission necessary.

Posthog Retrieve Session Property Definitions

Retrieve property definitions for a specific project by providing the project's id. access this get endpoint at `/api/projects/{project id}/sessions/property definitions/`. project id is mandatory. no response body is returned upon a successful call.

Posthog Retrieve Session Recording Details

Retrieve detailed information about a specific session recording by providing the session's uuid and associated project id. the response includes metrics such as duration, activity, timestamps, and user data. authentication is required.

Posthog Retrieve Session Recording Error Clusters

Retrieve error clusters from session recordings for a specified project. this endpoint provides details on user interactions, console logs, and activity times in json format, requiring the project id in the path.

Posthog Retrieve Session Recording Playlist Details

Retrieve session recording playlists for a specified project and playlist short id. returns details like name, creator info, and recordings. access by making a get request to `/api/projects/{project id}/session recording playlists/{short id}/recordings/`.

Posthog Retrieve Session Recording Properties

Retrieve properties of session recordings for a given project by id, including activity metrics, timestamps, and participant details. requires project id in the path. returns json data with recording details.

Posthog Retrieve Session Recording Snapshots

Snapshots for a session can be loaded from s3 (if old) or redis (if recent). clients call the api without a source to get supported sources, then per source for snapshots. api v1 is deprecated; clickhouse support removed.

Posthog Retrieve Similar Session Recordings

Retrieve similar session recordings for a given session by uuid within a project. details include session activity data, user info, and timestamps. requires `project id` and session `id`.

Posthog Retrieve Specific Batch Export Details

Retrieve details of a specific batch export for an organization by its uuid. requires a personalapikeyauth with 'batch export:read' permission. responses include export details like name, model, destination, interval, and more.

Posthog Retrieve Specific Batch Export Run Details

Retrieve details for a specific batch export run within a project by id. requires a uuid for batch export id and run id. provides run status, record count, timestamps, latest error, and intervals. security: personalapikeyauth.

Posthog Retrieve Specific Domain Details

Retrieve details of a specific domain within an organization using its uuid. authorized users can check domain verification status and saml configuration. requires the `personalapikeyauth` with `organization:read` scope.

Posthog Retrieve Specific Exported Asset Content

Retrieve the content of a specific exported asset by id within a project. requires 'export:read' permission. supports fetching details like creation time, format (png, pdf, csv, excel), etc.

Posthog Retrieve Specific Historical Plugin Export

Retrieve historical export data for a specific plugin configuration within a project. requires project, plugin config, and export item ids. auth via personalapikeyauth. no body in 200 response.

Posthog Retrieve Specific Pipeline Frontend App Config

Retrieve the configuration details of a specific pipeline frontend app by providing its unique id and the associated project id. permissions: 'plugin:read'. response includes plugin config info like enabled state and creation timestamp.

Posthog Retrieve Specific Project Dashboard Details

Retrieve details of a specific dashboard within a project. requires a dashboard id & project id, and returns information such as dashboard properties, owner, and access levels. auth: personalapikeyauth[dashboard:read].

Posthog Retrieve Survey Activity Logs

Retrieve activity logs for specific survey in a project, identified by uuids. requires valid api key with 'activity log:read' permissions. supports json response detailing survey's properties, types, and creator info.

Posthog Retrieve Survey Details With Uuid And Project Id

Retrieve survey details using survey uuid and associated project id. supports secure access with 'personalapikeyauth'. returns survey name, type, linking, targeting flags, creator info, and questions with branching logic descriptions.

Posthog Retrieve Survey Responses Count By Project Id

Retrieve the count of survey responses for a specific project by its id. it requires the project id parameter and returns details like the survey type, linked flags, and creator info.

Posthog Retrieve Unsubscribed Pipeline Configs

Retrieve config details for unsubscribed pipeline destinations in an organization. requires 'organization id' (uuid). returns plugin info, name, description, and more in json format.

Posthog Retrieve Unused Organization Pipeline Frontend Apps

Retrieve unused pipeline frontend apps for a specific organization by its uuid. returns details like app ids, types, names, descriptions, and other metadata in json format. requires organization id in path.

Posthog Retrieve Unused Organization Plugins

Retrieve a list of unused plugins for a specified organization by its uuid. the response includes plugin details such as type, name, and configuration. access restricted to the specified organization's context.

Posthog Retrieve Unused Pipeline Destinations

Retrieve unused pipeline destinations for a specified organization by id. this get endpoint returns a json object with details like destination id, plugin type, and url, among other attributes. (uuid for organization id is required.)

Posthog Retrieve User Details For Initiating 2 Fa Setup

The endpoint `get /api/users/{uuid}/start 2fa setup/` fetches details for initiating 2fa setup for a user, providing information like email status, password presence, and more. fields are mostly read-only.

Posthog Retrieve User Profile And Team Details

Fetch user info like profile, team, org, and notifications via uuid using personalapikeyauth ('user:read'). returns json with name, email, teams, and status.

Posthog Revoke Organization Invite

Delete an organization invite by its uuid. requires a valid personalapikeyauth with organization member write permission. no response body returned on success (http 204).

Posthog Set Insight Deletion Flag

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

Posthog Soft Delete A Specific Cohort By Id

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

Posthog Soft Delete Feature Flag By Setting Status

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

Posthog Soft Delete Project Dashboard

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

Posthog Split Person Entities In Project

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

Posthog Trigger Project Export With Format Option

The `/api/projects/{project id}/exports/` endpoint triggers a project export, requiring `project id` and `export format`. it accepts json, form-encoded, and multipart data, responding with a 201 code and export information.

Posthog Update Annotation Details

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

Posthog Update Early Access Project Feature

This patch endpoint updates a specific early access project feature. it requires `project id` and `id` (uuid) as path parameters. the body can include feature details like `name`, `description`, and `stage`. security: `personalapikeyauth`.

Posthog Update Event Definition By Uuid

Update an event definition by sending a put request to '/api/projects/{project id}/event definitions/{id}/' using the uuid and project id, provided you have 'event definition:write' authorization.

Posthog Update Experiment Details

Update an experiment by sending a put request with `project id` and `id`, including new details as json/form data. changes to name, description, dates, etc., allowed. `experiment:write` permission needed.

Posthog Update Feature Flag Configuration

Manage feature flags for your app with creation, reading, updating, and deletion options. utilize posthog's js library or endpoint for flag status. more info in docs.

Posthog Update Organization Details By Uuid

Update specific details of an organization using its uuid. allows patch requests with json, form data, or multipart. requires `organization:write` permission. returns updated organization info.

Posthog Update Organization Domain Info And Saml Config

Update a domain's info for a specific organization by id, including verification status and saml configuration. requires uuid path params and supports json, form-data content types.

Posthog Update Organization Domain Properties

Updates selected properties of a domain in an organization via patch request, supports various data formats but saml fields are immutable. authentication needed.

Posthog Update Organization Member By Uuids

Patch '/api/organizations/{id}/members/{uuid}': updates org member with user and org uuids. supports json/form/multipart. returns member data. secured by personalapikeyauth.

Posthog Update Organization Member Details

Update member details in an organization by id and user uuid. requires org member write permission. accepts json, form, or multipart. responses reflect member info, including roles and security settings.

Posthog Update Organization S Proxy Record Domain

Update a proxy record's domain details for a specified organization and proxy record id using put. requires organization and record ids, supports json, form, and multipart data. responses include status and timestamps. auth required.

Posthog Update Partial Project Cohort Details

Update partial cohort details for a specific project. requires a cohort id and project id, supports json, form data, and accepts patch changes like name or description. returns updated cohort data. auth required.

Posthog Update Partial Role Details In Organization

Patch /api/organizations/{organization id}/roles/{id}/: update partial details of a role by id within an organization, including name and feature flag access level. requires uuids for both organization and role. supports json, form, and multipart data.

Posthog Update Partial Subscription Details

Patch /api/projects/{project id}/subscriptions/{id}/: update partial details of a specific project subscription by id. modify target, frequency, and more. requires subscription:write permission.

Posthog Update Partial Survey Details

Update partial survey details by patch to /api/projects/{project id}/surveys/{id}/ with uuid. edit attributes like name, type, questions, targeting, and flags. needs personalapikeyauth for write access.

Posthog Update Person Properties

Request data's "properties" will be updated on a person using "$set" event, affecting only listed properties without deletion or other changes. for property removal, use 'delete property' endpoint.

Posthog Update Person Property Endpoint

This endpoint allows for reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.

Posthog Update Pipeline Destination Config

Update the configuration for a pipeline destination in a project. accepts a json, form-urlencoded, or multipart data payload to modify plugin settings by providing project and config ids. requires plugin:write authority. responds with updated data.

Posthog Update Pipeline Frontend App Config

Update configuration for a specific pipeline frontend app by providing its id and the project id. configure details like activation, order, and optional parameters via json or form data. authentication required.

Posthog Update Pipeline Plugin Config

Update a project-specific pipeline plugin configuration by supplying the project id and config id. this put request expects details like plugin state, order, and more in json, form data, or url-encoded format. authentication is required.

Posthog Update Pipeline Transformation Config

Update a pipeline transformation configuration for a specific project and config id. requires project id and config id in the path and json payload. supports plugin activation and order changes.

Posthog Update Plugin Config For Project

Update a plugin config's partial details in a project by its id using patch. requires project id, config id. accepts json/form data. authenticated with personalapikeyauth. returns updated config.

Posthog Update Project Action By Id

Put endpoint '/api/projects/{project id}/actions/{id}/' updates actions in a project by id, accepts json/form data, supports 'format' query, and needs 'action:write' authentication.

Posthog Update Project Action With Partial Data

Update an action within a project with a specified id. supports partial updates. accepts json, form-data, and query parameters including 'project id' and 'id'. formats response in csv or json. requires 'action:write' permission.

Posthog Update Project Cohort Details

Update cohort details of a specific project by id. requires project and cohort id in the path and a json, form-encoded, or multipart form body. permissions: cohort:write. returns updated cohort data.

Posthog Update Project Dashboard Details

Endpoint to update an existing dashboard within a project. provide `project id` and `dashboard id` in path, send json or form data with dashboard details. requires `dashboard:write` permission; responds with updated dashboard data.

Posthog Update Project Early Access Feature

Update a specific early access feature of a project by providing the `project id` and feature `id` (uuid). requires a json body with feature details and responds with the updated status. authentication via personalapikeyauth is mandatory.

Posthog Update Project Event Definition

Update an existing event definition for a specified project using its uuid. requires a project id and event definition write permissions. responds without a body on success.

Posthog Update Project Group Type Metadata

Patch /api/projects/{project id}/groups types/update metadata: update group type metadata for a specific project using its project id. can modify name singular and name plural fields up to 400 characters each.

Posthog Update Project Insight Details

Endpoint "/api/projects/{project id}/insights/{id}/" allows for updating an insight's details for a given project and insight id, supporting json and csv formats, with fields like name, query, and various timestamps. requires insight write permission.

Posthog Update Project Member Role By Uuid

Update a project member's role using their uuid in a specific project. accepts partial data to modify membership details such as role level, provided the member's uuid and project id.

Posthog Update Project Member S Role By Uuid

Update explicit project membership using uuids. this put endpoint modifies a project member's role, where '1' stands for member and '8' for administrator. requires `project id` and `parent membership user uuid`.

Posthog Update Project Notebook Details

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

Posthog Update Project Pipeline Destination Config

Update a project's pipeline destination config by id via patch api request. supports json/form requests, with fields like plugin & order. requires personalapikeyauth.

Posthog Update Project Pipeline Transformation Config

Update a specific pipeline transformation configuration for a project by providing a `project id` and configuration `id`. this patch request can modify properties like `plugin`, `enabled`, and `order`. authentication via a personal api key is required.

Posthog Update Project Plugin Configuration

Update project plugin config using its integer id and project string id; accepts json, url-encoded, or form-data. requires authentication; returns the updated config.

Posthog Update Project Property Definition

Update a property definition in a project by its uuid. requires a project id and definition id, both as path parameters. security: personalapikeyauth with write access. no body in the response.

Posthog Update Project Session Recording Playlist

Update an existing session recording playlist for a project with the specified project id and playlist short id. requires json or form data input to modify the playlist's properties like name, description, and status.

Posthog Update Project Subscription Details

Update a subscription for a specific project. provide project id and subscription id in the path and use mime types like application/json with fields like frequency, target type, etc. requires `subscription:write` permission.

Posthog Update Project Survey Details

The `/api/projects/{project id}/surveys/{id}/` put endpoint updates survey details in a project using survey uuid and project id, accepts json/form/multipart data, needs `survey:write` permission, and returns the updated survey.

Posthog Update Role Details In Organization

Update an organization role by submitting its uuid and organization id in uuid format. role details must be in json or form-data. only users with 'organization:write' can do this. returns updated role data.

Posthog Update Session Recording Playlist Partially

Update session recording playlists using patch on the endpoint with `project id` and `short id`. accepts json and forms data for detail amendments. partial updates allowed. `personalapikeyauth` needed.

Posthog Update Specific Proxy Record Fields

Patch `/api/organizations/{organization id}/proxy records/{id}/`: update specific fields of a proxy record by id within an organization. supports json, form data, and multipart. requires `organization:write` permission. returns updated proxy record.