PostHog

posthog

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

Analytics Web del proveedor

Acciones

358

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (358)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add dashboard collaborators with access levelPOSTHOG_ADD_DASHBOARD_COLLABORATORS_WITH_ACCESS_LEVELAcción

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

Parámetros de entrada

idstringObligatoriouuid
Id
added_atstringObligatoriodate-time
Added At
user_uuidstringObligatoriouuid
User Uuid
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
dashboard_idintegerObligatorio
Dashboard Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add member to organization rolePOSTHOG_ADD_MEMBER_TO_ORGANIZATION_ROLEAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
role_idstringObligatoriouuid
Role Id
joined_atstringObligatoriodate-time
Joined At
user_uuidstringObligatoriouuid
User Uuid
updated_atstringObligatoriodate-time
Updated At
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add project specific member rolesPOSTHOG_ADD_PROJECT_SPECIFIC_MEMBER_ROLESAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
joined_atstringObligatoriodate-time
Joined At
user_uuidstringObligatoriouuid
User Uuid
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
parent_levelintegerObligatorio
Parent Level
parent_membership_idstringObligatoriouuid
Parent Membership Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign feature flag role based accessPOSTHOG_ASSIGN_FEATURE_FLAG_ROLE_BASED_ACCESSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
role_idstringObligatoriouuid
Role Id
added_atstringObligatoriodate-time
Added At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
feature_flag_idintegerObligatorio
Feature Flag Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bookmark project activity notificationPOSTHOG_BOOKMARK_PROJECT_ACTIVITY_NOTIFICATIONAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
scopestringObligatorio
Scope
detailany
Detail
unreadbooleanObligatorio
is the date of this log item newer than the user"s bookmark
item_idstring
Item Id
activitystringObligatorio
Activity
user__idinteger
Id
is_systemboolean
Is System
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
user__uuidstringuuid
Uuid
user__emailstringemail
Email
organization_idstringuuid
Organization Id
user__last__namestring
Last Name
was_impersonatedboolean
Was Impersonated
user__first__namestring
First Name
user__distinct__idstring
Distinct Id
user__hedgehog__configobject
Hedgehog Config
user__is__email__verifiedboolean
Is Email Verified

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk create organization invitesPOSTHOG_BULK_CREATE_ORGANIZATION_INVITESAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
messagestring
Message
created_atstringObligatoriodate-time
Created At
first_namestring
First Name
is_expiredbooleanObligatorio
Check if invite is older than INVITE_DAYS_VALIDITY days.
send_emailboolean
Send Email
updated_atstringObligatoriodate-time
Updated At
target_emailstringObligatorioemail
Target Email
organization_idstringObligatorio
Organization Id
emailing_attempt_madebooleanObligatorio
Emailing Attempt Made
private_project_accessany
List of team IDs and corresponding access levels to private projects.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cancel insights for a projectPOSTHOG_CANCEL_INSIGHTS_FOR_A_PROJECTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check pipeline destination updatesPOSTHOG_CHECK_PIPELINE_DESTINATION_UPDATESAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check pipeline import app updatesPOSTHOG_CHECK_PIPELINE_IMPORT_APP_UPDATESAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check pipeline plugin update statusPOSTHOG_CHECK_PIPELINE_PLUGIN_UPDATE_STATUSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check project s demo data generation statusPOSTHOG_CHECK_PROJECT_S_DEMO_DATA_GENERATION_STATUSAcción

Projects for the current organization.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this team (soon to be environment).
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Cohort duplication to staticPOSTHOG_COHORT_DUPLICATION_TO_STATICAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this cohort.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a notebook in a projectPOSTHOG_CREATE_A_NOTEBOOK_IN_A_PROJECTAcción

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

Parámetros de entrada

idstringObligatoriouuid
Id
titlestring
Title
contentany
Content
deletedboolean
Deleted
versioninteger
Version
short_idstringObligatorio
Short Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
text_contentstring
Text Content
last_modified_atstringObligatoriodate-time
Last Modified At

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project insights with customizable parametersPOSTHOG_CREATE_CUSTOM_PROJECT_INSIGHTSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create dashboard from template in projectPOSTHOG_CREATE_DASHBOARD_FROM_TEMPLATE_IN_PROJECTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
tilesobject[]Obligatorio
Tiles
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
is_sharedbooleanObligatorio
Is Shared
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
use_templatestring
Use Template
use_dashboardinteger
Use Dashboard
delete_insightsboolean
Delete Insights

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create domain with saml for organizationPOSTHOG_CREATE_DOMAIN_WITH_SAML_FOR_ORGANIZATIONAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
domainstringObligatorio
Domain
has_samlbooleanObligatorio
Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places).
is_verifiedbooleanObligatorio
Determines whether a domain is verified or not.
verified_atstringObligatoriodate-time
Verified At
saml_acs_urlstring
Saml Acs Url
saml_entity_idstring
Saml Entity Id
saml_x509_certstring
Saml X509 Cert
organization_idstringObligatorio
Organization Id
sso_enforcementstring
Sso Enforcement
verification_challengestringObligatorio
Verification Challenge
jit_provisioning_enabledboolean
Jit Provisioning Enabled

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create experiment exposure cohortPOSTHOG_CREATE_EXPERIMENT_EXPOSURE_COHORTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
filtersany
Filters
archivedboolean
Archived
end_datestringdate-time
End Date
created_atstringObligatoriodate-time
Created At
parametersany
Parameters
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
exposure_cohortintegerObligatorio
Exposure Cohort
feature_flag_keystringObligatorio
Feature Flag Key
secondary_metricsany
Secondary Metrics

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create feature flag dashboardPOSTHOG_CREATE_FEATURE_FLAG_DASHBOARDAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
keystringObligatorio
Key
namestring
contains the description for the flag (field name `name` is kept for backwards-compatibility)
tagsarray
Tags
activeboolean
Active
deletedboolean
Deleted
filtersobject
Filters
surveysobjectObligatorio
Surveys
can_editbooleanObligatorio
Can Edit
featuresobjectObligatorio
Features
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
experiment_setinteger[]Obligatorio
Experiment Set
is_simple_flagbooleanObligatorio
Is Simple Flag
usage_dashboardintegerObligatorio
Usage Dashboard
performed_rollbackboolean
Performed Rollback
rollout_percentageintegerObligatorio
Rollout Percentage
rollback_conditionsany
Rollback Conditions
analytics_dashboardsinteger[]
Analytics Dashboards
has_enriched_analyticsboolean
Has Enriched Analytics
ensure_experience_continuityboolean
Ensure Experience Continuity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create feature flags for projectPOSTHOG_CREATE_FEATURE_FLAGS_FOR_PROJECTAcción

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

Parámetros de entrada

idintegerObligatorio
Id
keystringObligatorio
Key
namestring
contains the description for the flag (field name `name` is kept for backwards-compatibility)
tagsarray
Tags
activeboolean
Active
deletedboolean
Deleted
filtersobject
Filters
surveysobjectObligatorio
Surveys
can_editbooleanObligatorio
Can Edit
featuresobjectObligatorio
Features
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
experiment_setinteger[]Obligatorio
Experiment Set
is_simple_flagbooleanObligatorio
Is Simple Flag
usage_dashboardintegerObligatorio
Usage Dashboard
performed_rollbackboolean
Performed Rollback
rollout_percentageintegerObligatorio
Rollout Percentage
rollback_conditionsany
Rollback Conditions
analytics_dashboardsinteger[]
Analytics Dashboards
has_enriched_analyticsboolean
Has Enriched Analytics
ensure_experience_continuityboolean
Ensure Experience Continuity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create frontend app pipeline configPOSTHOG_CREATE_FRONTEND_APP_PIPELINE_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create funnel analysis for project personsPOSTHOG_CREATE_FUNNEL_ANALYSIS_FOR_PROJECT_PERSONSAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
uuidstringObligatoriouuid
Uuid
formatstringenum
Format
csvjson
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]Obligatorio
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create new organization with configurable accessPOSTHOG_CREATE_NEW_ORGANIZATION_WITH_CONFIGURABLE_ACCESSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
slugstringObligatorio
Slug
teamsobject[]Obligatorio
Teams
metadatastringObligatorio
Metadata
created_atstringObligatoriodate-time
Created At
updated_atstringObligatoriodate-time
Updated At
customer_idstringObligatorio
Customer Id
enforce_2faboolean
Enforce 2Fa
member_countstringObligatorio
Member Count
available_product_featuresarrayObligatorio
Available Product Features
is_member_join_email_enabledboolean
Is Member Join Email Enabled

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create new project experimentPOSTHOG_CREATE_NEW_PROJECT_EXPERIMENTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
filtersany
Filters
archivedboolean
Archived
end_datestringdate-time
End Date
created_atstringObligatoriodate-time
Created At
parametersany
Parameters
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
exposure_cohortintegerObligatorio
Exposure Cohort
feature_flag_keystringObligatorio
Feature Flag Key
secondary_metricsany
Secondary Metrics

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create organization invite with role and emailPOSTHOG_CREATE_ORGANIZATION_INVITE_WITH_ROLE_AND_EMAILAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
messagestring
Message
created_atstringObligatoriodate-time
Created At
first_namestring
First Name
is_expiredbooleanObligatorio
Check if invite is older than INVITE_DAYS_VALIDITY days.
send_emailboolean
Send Email
updated_atstringObligatoriodate-time
Updated At
target_emailstringObligatorioemail
Target Email
organization_idstringObligatorio
Organization Id
emailing_attempt_madebooleanObligatorio
Emailing Attempt Made
private_project_accessany
List of team IDs and corresponding access levels to private projects.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create organization role with feature flag levelsPOSTHOG_CREATE_ORGANIZATION_ROLE_WITH_FEATURE_FLAG_LEVELSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
membersstringObligatorio
Members
created_atstringObligatoriodate-time
Created At
organization_idstringObligatorio
Organization Id
associated_flagsstringObligatorio
Associated Flags

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create org proxy record with domain and statusPOSTHOG_CREATE_ORG_PROXY_RECORD_WITH_DOMAIN_AND_STATUSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
domainstringObligatorio
Domain
messagestringObligatorio
Message
created_atstringObligatoriodate-time
Created At
created_byintegerObligatorio
Created By
updated_atstringObligatoriodate-time
Updated At
target_cnamestringObligatorio
Target Cname
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create person funnel correlationPOSTHOG_CREATE_PERSON_FUNNEL_CORRELATIONAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
uuidstringObligatoriouuid
Uuid
formatstringenum
Format
csvjson
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]Obligatorio
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create person path with format optionPOSTHOG_CREATE_PERSON_PATH_WITH_FORMAT_OPTIONAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
uuidstringObligatoriouuid
Uuid
formatstringenum
Format
csvjson
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]Obligatorio
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create pipeline destination configPOSTHOG_CREATE_PIPELINE_DESTINATION_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create pipeline destination config jobPOSTHOG_CREATE_PIPELINE_DESTINATION_CONFIG_JOBAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create pipeline import apps config jobPOSTHOG_CREATE_PIPELINE_IMPORT_APPS_CONFIG_JOBAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create plugin job configurationPOSTHOG_CREATE_PLUGIN_JOB_CONFIGURATIONAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project action with formatPOSTHOG_CREATE_PROJECT_ACTION_WITH_FORMATAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
stepsobject[]
Steps
formatstringenum
Format
csvjson
deletedboolean
Deleted
team_idintegerObligatorio
Team Id
is_actionboolean
Is Action
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
post_to_slackboolean
Post To Slack
bytecode_errorstringObligatorio
Bytecode Error
is_calculatingbooleanObligatorio
Is Calculating
last_calculated_atstringdate-time
Last Calculated At
slack_message_formatstring
Slack Message Format

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project cohortsPOSTHOG_CREATE_PROJECT_COHORTSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
countintegerObligatorio
Count
queryany
Query
groupsany
Groups
deletedboolean
Deleted
filtersany
Filters
is_staticboolean
Is Static
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
experiment_setinteger[]Obligatorio
Experiment Set
is_calculatingbooleanObligatorio
Is Calculating
last_calculationstringObligatoriodate-time
Last Calculation
errors_calculatingintegerObligatorio
Errors Calculating

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project dashboardPOSTHOG_CREATE_PROJECT_DASHBOARDAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
tilesobject[]Obligatorio
Tiles
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
is_sharedbooleanObligatorio
Is Shared
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
use_templatestring
Use Template
use_dashboardinteger
Use Dashboard
delete_insightsboolean
Delete Insights

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project insights with format optionPOSTHOG_CREATE_PROJECT_INSIGHTS_WITH_FORMAT_OPTIONAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project pipeline app configsPOSTHOG_CREATE_PROJECT_PIPELINE_APP_CONFIGSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project pipeline frontend app jobPOSTHOG_CREATE_PROJECT_PIPELINE_FRONTEND_APP_JOBAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project pipeline transformation configPOSTHOG_CREATE_PROJECT_PIPELINE_TRANSFORMATION_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project plugin configurationPOSTHOG_CREATE_PROJECT_PLUGIN_CONFIGURATIONAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project subscription with delivery optionsPOSTHOG_CREATE_PROJECT_SUBSCRIPTION_WITH_DELIVERY_OPTIONSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
countinteger
Count
titlestring
Title
deletedboolean
Deleted
insightinteger
Insight
summarystringObligatorio
Summary
bysetposinteger
Bysetpos
intervalinteger
Interval
byweekdaystring[]
Byweekday
dashboardinteger
Dashboard
frequencystringObligatorioenum
* `daily` - Daily * `weekly` - Weekly * `monthly` - Monthly * `yearly` - Yearly
dailyweeklymonthlyyearly
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringObligatoriodate-time
Start Date
until_datestringdate-time
Until Date
target_typestringObligatorioenum
* `email` - Email * `slack` - Slack * `webhook` - Webhook
emailslackwebhook
target_valuestringObligatorio
Target Value
invite_messagestring
Invite Message
next_delivery_datestringObligatoriodate-time
Next Delivery Date

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project surveys with questions and targetsPOSTHOG_CREATE_PROJECT_SURVEYS_WITH_QUESTIONS_AND_TARGETSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
typestringObligatorioenum
* `popover` - popover * `widget` - widget * `button` - button * `email` - email * `full_screen` - full screen * `api` - api
popoverwidgetbuttonemailfull_screenapi
archivedboolean
Archived
end_datestringdate-time
End Date
questionsany
The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice. Basic (open-ended question) - `type`: `open` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `branching`: Branching logic for the question. See branching types below for details. Link (a question with a link) - `type`: `link` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `link`: The URL associated with the question. - `branching`: Branching logic for the question. See branching types below for details. Rating (a question with a rating scale) - `type`: `rating` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `display`: Display style of the rating (`number` or `emoji`). - `scale`: The scale of the rating (`number`). - `lowerBoundLabel`: Label for the lower bound of the scale. - `upperBoundLabel`: Label for the upper bound of the scale. - `branching`: Branching logic for the question. See branching types below for details. Multiple choice - `type`: `single_choice` or `multiple_choice` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `choices`: An array of choices for the question. - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`). - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`). - `branching`: Branching logic for the question. See branching types below for details. Branching logic can be one of the following types: Next question: Proceeds to the next question ```json { "type": "next_question" } ``` End: Ends the survey, optionally displaying a confirmation message. ```json { "type": "end" } ``` Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types. ```json { "type": "response_based", "responseValues": { "responseKey": "value" } } ``` Specific question: Proceeds to a specific question by index. ```json { "type": "specific_question", "index": 2 } ```
appearanceany
Appearance
conditionsany
Conditions
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
descriptionstring
Description
linked_flag_idinteger
Linked Flag Id
iteration_countinteger
Iteration Count
responses_limitinteger
Responses Limit
current_iterationinteger
Current Iteration
targeting_flag_idinteger
Targeting Flag Id
iteration_start_datesstring[]
Iteration Start Dates
remove_targeting_flagboolean
Remove Targeting Flag
targeting_flag_filtersany
Targeting Flag Filters
iteration_frequency_daysinteger
Iteration Frequency Days
current_iteration_start_datestringdate-time
Current Iteration Start Date

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create project timing insightsPOSTHOG_CREATE_PROJECT_TIMING_INSIGHTSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create query in project by idPOSTHOG_CREATE_QUERY_IN_PROJECT_BY_IDAcción

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.

Parámetros de entrada

asyncboolean
(Experimental) Whether to run the query asynchronously. Defaults to False. If True, the `id` of the query can be used to check the status and to cancel it.
queryobjectObligatorio
Submit a JSON string representing a query for PostHog data analysis, for example a HogQL query. Example payload: ``` {"query": {"kind": "HogQLQuery", "query": "select * from events limit 100"}} ``` For more details on HogQL queries, see the [PostHog HogQL documentation](/docs/hogql#api-access).
refreshboolean
Refresh
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
client_query_idstring
Client provided query ID. Can be used to retrieve the status or cancel the query.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create retrieve retention insights for projectPOSTHOG_CREATE_RETRIEVE_RETENTION_INSIGHTS_FOR_PROJECTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create session recording in playlistPOSTHOG_CREATE_SESSION_RECORDING_IN_PLAYLISTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
derived_namestring
Derived Name
last_modified_atstringObligatoriodate-time
Last Modified At
session_recording_idstringObligatorio
Session Recording Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create session recording playlistsPOSTHOG_CREATE_SESSION_RECORDING_PLAYLISTSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
derived_namestring
Derived Name
last_modified_atstringObligatoriodate-time
Last Modified At

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create session recording summaryPOSTHOG_CREATE_SESSION_RECORDING_SUMMARYAcción

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

Parámetros de entrada

idstringObligatorio
Id
viewedstringObligatorio
Viewed
storagestringObligatorio
Storage
end_timestringObligatoriodate-time
End Time
start_urlstringObligatorio
Start Url
person__idinteger
Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_timestringObligatoriodate-time
Start Time
click_countintegerObligatorio
Click Count
distinct_idstringObligatorio
Distinct Id
person__namestring
Name
person__uuidstringuuid
Uuid
active_secondsintegerObligatorio
Active Seconds
keypress_countintegerObligatorio
Keypress Count
snapshot_sourcestringObligatorio
Snapshot Source
inactive_secondsintegerObligatorio
Inactive Seconds
console_log_countintegerObligatorio
Console Log Count
console_warn_countintegerObligatorio
Console Warn Count
person__propertiesany
Properties
recording_durationintegerObligatorio
Recording Duration
console_error_countintegerObligatorio
Console Error Count
person__created__atstringdate-time
Created At
mouse_activity_countintegerObligatorio
Mouse Activity Count
person__distinct__idsstring
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create static cohort for feature flagPOSTHOG_CREATE_STATIC_COHORT_FOR_FEATURE_FLAGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
keystringObligatorio
Key
namestring
contains the description for the flag (field name `name` is kept for backwards-compatibility)
tagsarray
Tags
activeboolean
Active
deletedboolean
Deleted
filtersobject
Filters
surveysobjectObligatorio
Surveys
can_editbooleanObligatorio
Can Edit
featuresobjectObligatorio
Features
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
experiment_setinteger[]Obligatorio
Experiment Set
is_simple_flagbooleanObligatorio
Is Simple Flag
usage_dashboardintegerObligatorio
Usage Dashboard
performed_rollbackboolean
Performed Rollback
rollout_percentageintegerObligatorio
Rollout Percentage
rollback_conditionsany
Rollback Conditions
analytics_dashboardsinteger[]
Analytics Dashboards
has_enriched_analyticsboolean
Has Enriched Analytics
ensure_experience_continuityboolean
Ensure Experience Continuity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Crud operations for project annotationsPOSTHOG_CRUD_OPERATIONS_FOR_PROJECT_ANNOTATIONSAcción

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

Parámetros de entrada

idintegerObligatorio
Id
scopestringenum
* `dashboard_item` - insight * `dashboard` - dashboard * `project` - project * `organization` - organization
dashboard_itemdashboardprojectorganization
contentstring
Content
deletedboolean
Deleted
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
date_markerstringdate-time
Date Marker
dashboard_idintegerObligatorio
Dashboard Id
insight_namestringObligatorio
Insight Name
creation_typestringenum
* `USR` - user * `GIT` - GitHub
USRGIT
dashboard_iteminteger
Dashboard Item
dashboard_namestringObligatorio
Dashboard Name
insight_short_idstringObligatorio
Insight Short Id
insight_derived_namestringObligatorio
Insight Derived Name

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Project Funnel Advanced AnalyticsPOSTHOG_CUSTOM_PROJECT_FUNNEL_ANALYTICS_WITH_ADVANCED_OPTIONSAcción

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.

Parámetros de entrada

eventsobject[]
Events to filter on. One of `events` or `actions` is required.
formatstringenum
Format
csvjson
actionsobject[]
Actions to filter on. One of `events` or `actions` is required.
date_tostring
What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.
breakdownstring
A property or cohort to break down on. You can select the type of the property with breakdown_type. - `event` (default): a property key - `person`: a person property key - `cohort`: an array of cohort IDs (ie `[9581,5812]`)
date_fromstring
What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.
exclusionsobject[]
Exclude users/groups that completed the specified event between two specific steps. Note that these users/groups will be completely excluded from the entire funnel.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
breakdown_limitinteger
Breakdown Limit
funnel_window_daysinteger
(DEPRECATED) Funnel window size in days. Use `funnel_window_interval` and `funnel_window_interval_type`
filter_test_accountsboolean
Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.
funnel_window_intervalinteger
Funnel window size. Set in combination with funnel_window_interval, so defaults to "days".
aggregation_group_type_indexinteger
Aggregate by users or by groups. `0` means user, `>0` means a group. See interface for the corresponding ID of the group.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete organization by uuidPOSTHOG_DELETE_ORGANIZATION_BY_UUIDAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this organization.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete organization projectPOSTHOG_DELETE_ORGANIZATION_PROJECTAcción

Projects for the current organization.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this team (soon to be environment).
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete person and optionally associated eventsPOSTHOG_DELETE_PERSON_AND_OPTIONALLY_ASSOCIATED_EVENTSAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this person.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
delete_eventsboolean
If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday (controlled by environment variable CLEAR_CLICKHOUSE_REMOVED_DATA_SCHEDULE_CRON)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete session recording by uuidPOSTHOG_DELETE_SESSION_RECORDING_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this session recording.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete survey by idPOSTHOG_DELETE_SURVEY_BY_IDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this survey.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enable project early access featurePOSTHOG_ENABLE_PROJECT_EARLY_ACCESS_FEATUREAcción

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

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
stagestringObligatorioenum
* `draft` - draft * `concept` - concept * `alpha` - alpha * `beta` - beta * `general-availability` - general availability * `archived` - archived
draftconceptalphabetageneral-availabilityarchived
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
feature_flag_idinteger
Feature Flag Id
documentation_urlstringuri
Documentation Url

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch batch export details via uuidPOSTHOG_FETCH_BATCH_EXPORT_DETAILS_VIA_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch export unsubscribe settingsPOSTHOG_FETCH_EXPORT_UNSUBSCRIBE_SETTINGSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch frontend app config statusPOSTHOG_FETCH_FRONTEND_APP_CONFIG_STATUSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch organization details by uuidPOSTHOG_FETCH_ORGANIZATION_DETAILS_BY_UUIDAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this organization.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch organization pipeline app repositoriesPOSTHOG_FETCH_ORGANIZATION_PIPELINE_APP_REPOSITORIESAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

FetchpipelinedestinationdetailsPOSTHOG_FETCH_PIPELINE_DESTINATION_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch pipeline transformation detailsPOSTHOG_FETCH_PIPELINE_TRANSFORMATION_DETAILSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch project experiment secondary dataPOSTHOG_FETCH_PROJECT_EXPERIMENT_SECONDARY_DATAAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this experiment.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch project survey activity logPOSTHOG_FETCH_PROJECT_SURVEY_ACTIVITY_LOGAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch session recording playlist detailsPOSTHOG_FETCH_SESSION_RECORDING_PLAYLIST_DETAILSAcción

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.

Parámetros de entrada

short_idstringObligatorio
Short Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Flag annotation as deletedPOSTHOG_FLAG_ANNOTATION_AS_DELETEDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this annotation.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate project funnel correlation insightPOSTHOG_GENERATE_PROJECT_FUNNEL_CORRELATION_INSIGHTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve unused organization pipeline frontend appsPOSTHOG_GET_UNUSED_ORG_PIPELINE_FRONTEND_APPSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Initiate domain verification with saml configPOSTHOG_INITIATE_DOMAIN_VERIFICATION_WITH_SAML_CONFIGAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
domainstringObligatorio
Domain
has_samlbooleanObligatorio
Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places).
is_verifiedbooleanObligatorio
Determines whether a domain is verified or not.
verified_atstringObligatoriodate-time
Verified At
saml_acs_urlstring
Saml Acs Url
saml_entity_idstring
Saml Entity Id
saml_x509_certstring
Saml X509 Cert
organization_idstringObligatorio
Organization Id
sso_enforcementstring
Sso Enforcement
verification_challengestringObligatorio
Verification Challenge
jit_provisioning_enabledboolean
Jit Provisioning Enabled

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Initiate pipeline transformation jobPOSTHOG_INITIATE_PIPELINE_TRANSFORMATION_JOBAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List and filter project eventsPOSTHOG_LIST_AND_FILTER_PROJECT_EVENTSAcción

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.

Parámetros de entrada

afterstring
Only return events with a timestamp after this time.
eventstring
Filter list by event. For example `user sign up` or `$pageview`.
limitinteger
The maximum number of results to return
wherestring[]
(Experimental) JSON-serialized array of HogQL expressions that must pass
beforestring
Only return events with a timestamp before this time.
formatstringenum
Format
csvjson
offsetinteger
The initial index from which to return the results.
selectstring[]
(Experimental) JSON-serialized array of HogQL expressions to return
person_idinteger
Filter list by person id.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesobject[]
Filter events by event property, person property, cohort, groups and more.
distinct_idinteger
Filter list by distinct id.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List and manage project annotationsPOSTHOG_LIST_AND_MANAGE_PROJECT_ANNOTATIONSAcción

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

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
searchstring
A search term.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List and manage project feature flagsPOSTHOG_LIST_AND_MANAGE_PROJECT_FEATURE_FLAGSAcción

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

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Batch Export RunsPOSTHOG_LIST_BATCH_EXPORT_RUNS_WITH_PAGINATION_AND_ORDERINGAcción

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.

Parámetros de entrada

cursorstring
The pagination cursor value.
orderingstring
Which field to use when ordering the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
batch_export_idstringObligatorio
Batch Export Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List dashboard sharing configsPOSTHOG_LIST_DASHBOARD_SHARING_CONFIGSAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
dashboard_idintegerObligatorio
Dashboard Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List feature flag role access detailsPOSTHOG_LIST_FEATURE_FLAG_ROLE_ACCESS_DETAILSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
feature_flag_idintegerObligatorio
Feature Flag Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List notebooks with filters and paginationPOSTHOG_LIST_NOTEBOOKS_WITH_FILTERS_AND_PAGINATIONAcción

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

Parámetros de entrada

userstring
If any value is provided for this parameter, return notebooks created by the logged in user.
limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
date_tostring
Filter for notebooks created before this date & time
containsstring
Filter for notebooks that match a provided filter. Each match pair is separated by a colon, multiple match pairs can be sent separated by a space or a comma
date_fromstring
Filter for notebooks created after this date & time
created_byinteger
The UUID of the Notebook"s creator
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List of project s session recording playlistsPOSTHOG_LIST_OF_PROJECT_S_SESSION_RECORDING_PLAYLISTSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
short_idstring
Short Id
created_byinteger
Created By
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List or delete persons with optional filtersPOSTHOG_LIST_OR_DELETE_PERSONS_WITH_OPTIONAL_FILTERSAcción

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

Parámetros de entrada

emailstring
Filter persons by email (exact match)
limitinteger
Number of results to return per page.
formatstringenum
Format
csvjson
offsetinteger
The initial index from which to return the results.
searchstring
Search persons, either by email (full text search) or distinct_id (exact match).
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesobject[]
Filter Persons by person properties.
distinct_idstring
Filter list by distinct id.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization domains with paginationPOSTHOG_LIST_ORGANIZATION_DOMAINS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization invites with paginationPOSTHOG_LIST_ORGANIZATION_INVITES_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization members with paginationPOSTHOG_LIST_ORGANIZATION_MEMBERS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

ListorganizationpluginswithpaginationPOSTHOG_LIST_ORGANIZATION_PLUGINS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization roles with paginationPOSTHOG_LIST_ORGANIZATION_ROLES_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization s batch exports with paginationPOSTHOG_LIST_ORGANIZATION_S_BATCH_EXPORTS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization s paginated proxy recordsPOSTHOG_LIST_ORGANIZATION_S_PAGINATED_PROXY_RECORDSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization s pipeline destinationsPOSTHOG_LIST_ORGANIZATION_S_PIPELINE_DESTINATIONSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization s pipeline frontend appsPOSTHOG_LIST_ORGANIZATION_S_PIPELINE_FRONTEND_APPSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization s pipeline import appsPOSTHOG_LIST_ORGANIZATION_S_PIPELINE_IMPORT_APPSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List organization s pipeline transformationsPOSTHOG_LIST_ORGANIZATION_S_PIPELINE_TRANSFORMATIONSAcción

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

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List paginated surveys for a projectPOSTHOG_LIST_PAGINATED_SURVEYS_FOR_A_PROJECTAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List pipeline destination configs with paginationPOSTHOG_LIST_PIPELINE_DESTINATION_CONFIGS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List pipeline frontend app configsPOSTHOG_LIST_PIPELINE_FRONTEND_APP_CONFIGSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project actions with pagination and filtersPOSTHOG_LIST_PROJECT_ACTIONS_WITH_PAGINATION_AND_FILTERSAcción

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

Parámetros de entrada

limitinteger
Number of results to return per page.
formatstringenum
Format
csvjson
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project batch exports with paginationPOSTHOG_LIST_PROJECT_BATCH_EXPORTS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project configuration plugin logsPOSTHOG_LIST_PROJECT_CONFIGURATION_PLUGIN_LOGSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
plugin_config_idstringObligatorio
Plugin Config Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project dashboard collaboratorsPOSTHOG_LIST_PROJECT_DASHBOARD_COLLABORATORSAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
dashboard_idintegerObligatorio
Dashboard Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project dashboards with paginationPOSTHOG_LIST_PROJECT_DASHBOARDS_WITH_PAGINATIONAcción

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

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project dashboard templatesPOSTHOG_LIST_PROJECT_DASHBOARD_TEMPLATESAcción

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

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project early access featuresPOSTHOG_LIST_PROJECT_EARLY_ACCESS_FEATURESAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project experiments with paginationPOSTHOG_LIST_PROJECT_EXPERIMENTS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project export items with paginationPOSTHOG_LIST_PROJECT_EXPORT_ITEMS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project group types by idPOSTHOG_LIST_PROJECT_GROUP_TYPES_BY_IDAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project membership detailsPOSTHOG_LIST_PROJECT_MEMBERSHIP_DETAILSAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project pipeline configurationsPOSTHOG_LIST_PROJECT_PIPELINE_CONFIGURATIONSAcción

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

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

ListprojectpipelineimportconfigsPOSTHOG_LIST_PROJECT_PIPELINE_IMPORT_CONFIGSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project plugin configurationsPOSTHOG_LIST_PROJECT_PLUGIN_CONFIGURATIONSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project session recordingsPOSTHOG_LIST_PROJECT_SESSION_RECORDINGSAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List projects in organization with paginationPOSTHOG_LIST_PROJECTS_IN_ORGANIZATION_WITH_PAGINATIONAcción

Projects for the current organization.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List project subscriptions with paginationPOSTHOG_LIST_PROJECT_SUBSCRIPTIONS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

ListrolemembershipspaginatedPOSTHOG_LIST_ROLE_MEMBERSHIPS_PAGINATEDAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
role_idstringObligatorio
Role Id
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List session recording sharing configsPOSTHOG_LIST_SESSION_RECORDING_SHARING_CONFIGSAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
recording_idstringObligatorio
Recording Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List specific type groups with paginationPOSTHOG_LIST_SPECIFIC_TYPE_GROUPS_WITH_PAGINATIONAcción

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/

Parámetros de entrada

cursorstring
The pagination cursor value.
searchstringObligatorio
Search the group name
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
group_type_indexintegerObligatorio
Specify the group type to list

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List unused organization pipeline transformationsPOSTHOG_LIST_UNUSED_ORGANIZATION_PIPELINE_TRANSFORMATIONSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List users with staff filter and paginationPOSTHOG_LIST_USERS_WITH_STAFF_FILTER_AND_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
is_staffboolean
Is Staff

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Manage feature flag enrichment for usage dashboardPOSTHOG_MANAGE_FEATURE_FLAG_ENRICHMENT_FOR_USAGE_DASHBOARDAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
keystringObligatorio
Key
namestring
contains the description for the flag (field name `name` is kept for backwards-compatibility)
tagsarray
Tags
activeboolean
Active
deletedboolean
Deleted
filtersobject
Filters
surveysobjectObligatorio
Surveys
can_editbooleanObligatorio
Can Edit
featuresobjectObligatorio
Features
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
experiment_setinteger[]Obligatorio
Experiment Set
is_simple_flagbooleanObligatorio
Is Simple Flag
usage_dashboardintegerObligatorio
Usage Dashboard
performed_rollbackboolean
Performed Rollback
rollout_percentageintegerObligatorio
Rollout Percentage
rollback_conditionsany
Rollback Conditions
analytics_dashboardsinteger[]
Analytics Dashboards
has_enriched_analyticsboolean
Has Enriched Analytics
ensure_experience_continuityboolean
Ensure Experience Continuity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Manage project feature flagsPOSTHOG_MANAGE_PROJECT_FEATURE_FLAGSAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Manage project feature flags for local evaluationPOSTHOG_MANAGE_PROJECT_FEATURE_FLAGS_FOR_LOCAL_EVALUATIONAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Manage user feature flagsPOSTHOG_MANAGE_USER_FEATURE_FLAGSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
keystringObligatorio
Key
namestring
contains the description for the flag (field name `name` is kept for backwards-compatibility)
tagsarray
Tags
activeboolean
Active
deletedboolean
Deleted
filtersobject
Filters
surveysobjectObligatorio
Surveys
can_editbooleanObligatorio
Can Edit
featuresobjectObligatorio
Features
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
experiment_setinteger[]Obligatorio
Experiment Set
is_simple_flagbooleanObligatorio
Is Simple Flag
usage_dashboardintegerObligatorio
Usage Dashboard
performed_rollbackboolean
Performed Rollback
rollout_percentageintegerObligatorio
Rollout Percentage
rollback_conditionsany
Rollback Conditions
analytics_dashboardsinteger[]
Analytics Dashboards
has_enriched_analyticsboolean
Has Enriched Analytics
ensure_experience_continuityboolean
Ensure Experience Continuity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark dashboard template as deletedPOSTHOG_MARK_DASHBOARD_TEMPLATE_AS_DELETEDAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this dashboard template.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark insight as viewed with configurable formatPOSTHOG_MARK_INSIGHT_AS_VIEWED_WITH_CONFIGURABLE_FORMATAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark project action as deletedPOSTHOG_MARK_PROJECT_ACTION_AS_DELETEDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this action.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark session recording playlist deletedPOSTHOG_MARK_SESSION_RECORDING_PLAYLIST_DELETEDAcción

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

Parámetros de entrada

short_idstringObligatorio
Short Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark subscription as deleted by idPOSTHOG_MARK_SUBSCRIPTION_AS_DELETED_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this subscription.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify org info via uuidPOSTHOG_MODIFY_ORG_INFO_VIA_UUIDAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
slugstringObligatorio
Slug
teamsobject[]Obligatorio
Teams
metadatastringObligatorio
Metadata
created_atstringObligatoriodate-time
Created At
updated_atstringObligatoriodate-time
Updated At
customer_idstringObligatorio
Customer Id
enforce_2faboolean
Enforce 2Fa
member_countstringObligatorio
Member Count
available_product_featuresarrayObligatorio
Available Product Features
is_member_join_email_enabledboolean
Is Member Join Email Enabled

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move dashboard tilePOSTHOG_MOVE_DASHBOARD_TILEAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
tilesobject[]
Tiles
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
is_sharedboolean
Is Shared
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
use_templatestring
Use Template
use_dashboardinteger
Use Dashboard
delete_insightsboolean
Delete Insights

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partial experiment update in projectPOSTHOG_PARTIAL_EXPERIMENT_UPDATE_IN_PROJECTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
filtersany
Filters
archivedboolean
Archived
end_datestringdate-time
End Date
created_atstringdate-time
Created At
parametersany
Parameters
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
updated_atstringdate-time
Updated At
descriptionstring
Description
exposure_cohortinteger
Exposure Cohort
feature_flag_keystring
Feature Flag Key
secondary_metricsany
Secondary Metrics

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partially update project plugin configPOSTHOG_PARTIALLY_UPDATE_PROJECT_PLUGIN_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partially update project property definitionPOSTHOG_PARTIALLY_UPDATE_PROJECT_PROPERTY_DEFINITIONAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this property definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partial pipeline frontend app config updatePOSTHOG_PARTIAL_PIPELINE_FRONTEND_APP_CONFIG_UPDATEAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partial update of a project insightPOSTHOG_PARTIAL_UPDATE_OF_A_PROJECT_INSIGHTAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstring
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstring
Types
formatstringenum
Format
csvjson
resultstring
Result
columnsstring
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstring
Short Id
timezonestring
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstring
Is Cached
is_sampleboolean
Is Sample
created_atstringdate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstring
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstring
Query Status
dashboard_tilesobject[]
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestring
The target age of the cached results for this insight.
last_modified_atstringdate-time
Last Modified At
next_allowed_client_refreshstring
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partial update of a project s dashboardPOSTHOG_PARTIAL_UPDATE_OF_A_PROJECT_S_DASHBOARDAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
tilesobject[]
Tiles
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
is_sharedboolean
Is Shared
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
use_templatestring
Use Template
use_dashboardinteger
Use Dashboard
delete_insightsboolean
Delete Insights

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partial update of a project s feature flagPOSTHOG_PARTIAL_UPDATE_OF_A_PROJECT_S_FEATURE_FLAGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
keystring
Key
namestring
contains the description for the flag (field name `name` is kept for backwards-compatibility)
tagsarray
Tags
activeboolean
Active
deletedboolean
Deleted
filtersobject
Filters
surveysobject
Surveys
can_editboolean
Can Edit
featuresobject
Features
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
experiment_setinteger[]
Experiment Set
is_simple_flagboolean
Is Simple Flag
usage_dashboardinteger
Usage Dashboard
performed_rollbackboolean
Performed Rollback
rollout_percentageinteger
Rollout Percentage
rollback_conditionsany
Rollback Conditions
analytics_dashboardsinteger[]
Analytics Dashboards
has_enriched_analyticsboolean
Has Enriched Analytics
ensure_experience_continuityboolean
Ensure Experience Continuity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partial update of project notebookPOSTHOG_PARTIAL_UPDATE_OF_PROJECT_NOTEBOOKAcción

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

Parámetros de entrada

idstringuuid
Id
titlestring
Title
contentany
Content
deletedboolean
Deleted
versioninteger
Version
short_idstringObligatorio
Short Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
text_contentstring
Text Content
last_modified_atstringdate-time
Last Modified At

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Partial update project annotationPOSTHOG_PARTIAL_UPDATE_PROJECT_ANNOTATIONAcción

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

Parámetros de entrada

idintegerObligatorio
Id
scopestringenum
* `dashboard_item` - insight * `dashboard` - dashboard * `project` - project * `organization` - organization
dashboard_itemdashboardprojectorganization
contentstring
Content
deletedboolean
Deleted
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
date_markerstringdate-time
Date Marker
dashboard_idinteger
Dashboard Id
insight_namestring
Insight Name
creation_typestringenum
* `USR` - user * `GIT` - GitHub
USRGIT
dashboard_iteminteger
Dashboard Item
dashboard_namestring
Dashboard Name
insight_short_idstring
Insight Short Id
insight_derived_namestring
Insight Derived Name

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Persist session recording data by uuidPOSTHOG_PERSIST_SESSION_RECORDING_DATA_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
Id
viewedstringObligatorio
Viewed
storagestringObligatorio
Storage
end_timestringObligatoriodate-time
End Time
start_urlstringObligatorio
Start Url
person__idinteger
Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_timestringObligatoriodate-time
Start Time
click_countintegerObligatorio
Click Count
distinct_idstringObligatorio
Distinct Id
person__namestring
Name
person__uuidstringuuid
Uuid
active_secondsintegerObligatorio
Active Seconds
keypress_countintegerObligatorio
Keypress Count
snapshot_sourcestringObligatorio
Snapshot Source
inactive_secondsintegerObligatorio
Inactive Seconds
console_log_countintegerObligatorio
Console Log Count
console_warn_countintegerObligatorio
Console Warn Count
person__propertiesany
Properties
recording_durationintegerObligatorio
Recording Duration
console_error_countintegerObligatorio
Console Error Count
person__created__atstringdate-time
Created At
mouse_activity_countintegerObligatorio
Mouse Activity Count
person__distinct__idsstring
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Person partial update via project idPOSTHOG_PERSON_PARTIAL_UPDATE_VIA_PROJECT_IDAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
uuidstringuuid
Uuid
formatstringenum
Format
csvjson
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Person property deletion endpointPOSTHOG_PERSON_PROPERTY_DELETION_ENDPOINTAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
uuidstringObligatoriouuid
Uuid
unsetstringObligatorio
Specify the property key to delete
formatstringenum
Format
csvjson
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]Obligatorio
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Prevent hard delete notebook by flaggingPOSTHOG_PREVENT_HARD_DELETE_NOTEBOOK_BY_FLAGGINGAcción

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

Parámetros de entrada

short_idstringObligatorio
Short Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post Project Trends With FiltersPOSTHOG_PROJECT_TREND_ANALYTICSAcción

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.

Parámetros de entrada

eventsobject[]
Events to filter on. One of `events` or `actions` is required.
formatstringenum
Format
csvjson
actionsobject[]
Actions to filter on. One of `events` or `actions` is required.
compareboolean
To compare or not
date_tostring
What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.
formulastring
Combine the result of events or actions into a single number. For example `A + B` or `(A-B)/B`. The letters correspond to the order of the `events` or `actions` lists.
breakdownstring
A property or cohort to break down on. You can select the type of the property with breakdown_type. - `event` (default): a property key - `person`: a person property key - `cohort`: an array of cohort IDs (ie `[9581,5812]`)
date_fromstring
What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year.
compare_tostring
What to compare to
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
filter_test_accountsboolean
Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rearrange frontend app pipeline configsPOSTHOG_REARRANGE_FRONTEND_APP_PIPELINE_CONFIGSAcción

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.

Parámetros de entrada

idinteger
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rearrange pipeline transformation configsPOSTHOG_REARRANGE_PIPELINE_TRANSFORMATION_CONFIGSAcción

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.

Parámetros de entrada

idinteger
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rearrange project import app configurationsPOSTHOG_REARRANGE_PROJECT_IMPORT_APP_CONFIGURATIONSAcción

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.

Parámetros de entrada

idinteger
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rearrange project pipeline destination configsPOSTHOG_REARRANGE_PROJECT_PIPELINE_DESTINATION_CONFIGSAcción

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

Parámetros de entrada

idinteger
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reconfigure plugin order and status in projectPOSTHOG_RECONFIGURE_PLUGIN_ORDER_AND_STATUS_IN_PROJECTAcción

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.

Parámetros de entrada

idinteger
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove domain by uuid from organizationPOSTHOG_REMOVE_DOMAIN_BY_UUID_FROM_ORGANIZATIONAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this domain.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove early access feature from projectPOSTHOG_REMOVE_EARLY_ACCESS_FEATURE_FROM_PROJECTAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this early access feature.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove explicit project member by uuidPOSTHOG_REMOVE_EXPLICIT_PROJECT_MEMBER_BY_UUIDAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
parent__membership__user__uuidstringObligatorio
Parent Membership User Uuid

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove feature flag role access by idPOSTHOG_REMOVE_FEATURE_FLAG_ROLE_ACCESS_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this feature flag role access.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
feature_flag_idintegerObligatorio
Feature Flag Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove member from organization by uuidPOSTHOG_REMOVE_MEMBER_FROM_ORGANIZATION_BY_UUIDAcción

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.

Parámetros de entrada

user__uuidstringObligatorio
User Uuid
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove organization batch export by uuidPOSTHOG_REMOVE_ORGANIZATION_BATCH_EXPORT_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove organization pipeline destinationPOSTHOG_REMOVE_ORGANIZATION_PIPELINE_DESTINATIONAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove organization pipeline transformationPOSTHOG_REMOVE_ORGANIZATION_PIPELINE_TRANSFORMATIONAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove organization plugin by idPOSTHOG_REMOVE_ORGANIZATION_PLUGIN_BY_IDAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove organization proxy recordPOSTHOG_REMOVE_ORGANIZATION_PROXY_RECORDAcción

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.

Parámetros de entrada

idstringObligatorio
Id
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove organization role by idPOSTHOG_REMOVE_ORGANIZATION_ROLE_BY_IDAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this role.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove org pipeline import app by idPOSTHOG_REMOVE_ORG_PIPELINE_IMPORT_APP_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove pipeline destination configPOSTHOG_REMOVE_PIPELINE_DESTINATION_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove pipeline frontend app by idPOSTHOG_REMOVE_PIPELINE_FRONTEND_APP_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove pipeline frontend app configPOSTHOG_REMOVE_PIPELINE_FRONTEND_APP_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove pipeline import app configPOSTHOG_REMOVE_PIPELINE_IMPORT_APP_CONFIGAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove pipeline transformation config by idPOSTHOG_REMOVE_PIPELINE_TRANSFORMATION_CONFIG_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove project dashboard collaboratorPOSTHOG_REMOVE_PROJECT_DASHBOARD_COLLABORATORAcción

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

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
user__uuidstringObligatorio
User Uuid
dashboard_idintegerObligatorio
Dashboard Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove project event definitionPOSTHOG_REMOVE_PROJECT_EVENT_DEFINITIONAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this event definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove project experiment by idPOSTHOG_REMOVE_PROJECT_EXPERIMENT_BY_IDAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this experiment.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove project plugin configurationPOSTHOG_REMOVE_PROJECT_PLUGIN_CONFIGURATIONAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove property definition by uuidPOSTHOG_REMOVE_PROPERTY_DEFINITION_BY_UUIDAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this property definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove rolemembership by uuidPOSTHOG_REMOVE_ROLE_MEMBERSHIP_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this role membership.
role_idstringObligatorio
Role Id
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove session recording from playlistPOSTHOG_REMOVE_SESSION_RECORDING_FROM_PLAYLISTAcción

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

Parámetros de entrada

short_idstringObligatorio
Short Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
session_recording_idstringObligatorio
Session Recording Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove specific project batch exportPOSTHOG_REMOVE_SPECIFIC_PROJECT_BATCH_EXPORTAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove specific project queryPOSTHOG_REMOVE_SPECIFIC_PROJECT_QUERYAcción

(experimental)

Parámetros de entrada

idstringObligatorio
Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve and delete project person trendsPOSTHOG_RETRIEVE_AND_DELETE_PROJECT_PERSON_TRENDSAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve app metrics by idsPOSTHOG_RETRIEVE_APP_METRICS_BY_IDSAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve app metrics error detailsPOSTHOG_RETRIEVE_APP_METRICS_ERROR_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve async query status by idPOSTHOG_RETRIEVE_ASYNC_QUERY_STATUS_BY_IDAcción

(experimental)

Parámetros de entrada

idstringObligatorio
Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve batch export detailsPOSTHOG_RETRIEVE_BATCH_EXPORT_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve batch export logs by uuidPOSTHOG_RETRIEVE_BATCH_EXPORT_LOGS_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve batch export run logsPOSTHOG_RETRIEVE_BATCH_EXPORT_RUN_LOGSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export run.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
batch_export_idstringObligatorio
Batch Export Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve cohort activity detailsPOSTHOG_RETRIEVE_COHORT_ACTIVITY_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this cohort.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve cohort person detailsPOSTHOG_RETRIEVE_COHORT_PERSON_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this cohort.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve dashboard template details by uuidPOSTHOG_RETRIEVE_DASHBOARD_TEMPLATE_DETAILS_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this dashboard template.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve dashboard template schemaPOSTHOG_RETRIEVE_DASHBOARD_TEMPLATE_SCHEMAAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve event definition by uuidPOSTHOG_RETRIEVE_EVENT_DEFINITION_BY_UUIDAcción

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})

Parámetros de entrada

idstringObligatorio
A UUID string identifying this event definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve event definitions by project idPOSTHOG_RETRIEVE_EVENT_DEFINITIONS_BY_PROJECT_IDAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve experiment details by idsPOSTHOG_RETRIEVE_EXPERIMENT_DETAILS_BY_IDSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this experiment.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve experiments requiring flag implementationPOSTHOG_RETRIEVE_EXPERIMENTS_REQUIRING_FLAG_IMPLEMENTATIONAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve export unsubscribe configsPOSTHOG_RETRIEVE_EXPORT_UNSUBSCRIBE_CONFIGSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve feature flag activity detailsPOSTHOG_RETRIEVE_FEATURE_FLAG_ACTIVITY_DETAILSAcción

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)

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this feature flag.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve feature flag detailsPOSTHOG_RETRIEVE_FEATURE_FLAG_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this feature flag.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve feature flag role access detailsPOSTHOG_RETRIEVE_FEATURE_FLAG_ROLE_ACCESS_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this feature flag role access.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
feature_flag_idintegerObligatorio
Feature Flag Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve feature flags activity logPOSTHOG_RETRIEVE_FEATURE_FLAGS_ACTIVITY_LOGAcción

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

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve feature flags evaluation reasonsPOSTHOG_RETRIEVE_FEATURE_FLAGS_EVALUATION_REASONSAcción

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

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve filtered project property definitionsPOSTHOG_RETRIEVE_FILTERED_PROJECT_PROPERTY_DEFINITIONSAcción

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.

Parámetros de entrada

typestringenum
What property definitions to return * `event` - event * `person` - person * `group` - group * `session` - session
eventpersongroupsession
searchstring
Searches properties by name
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesstring
Comma-separated list of properties to filter
event_namesstring
If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded
is_numericalboolean
Whether to return only (or excluding) numerical property definitions
is_feature_flagboolean
Whether to return only (or excluding) feature flag properties
group_type_indexinteger
What group type is the property for. Only should be set if `type=group`
excluded_propertiesstring
JSON-encoded list of excluded properties
filter_by_event_namesboolean
Whether to return only properties for events in `event_names`

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve funnel insights in projectPOSTHOG_RETRIEVE_FUNNEL_INSIGHTS_IN_PROJECTAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve group property definitions by project idPOSTHOG_RETRIEVE_GROUP_PROPERTY_DEFINITIONS_BY_PROJECT_IDAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve group property values by index and keyPOSTHOG_RETRIEVE_GROUP_PROPERTY_VALUES_BY_INDEX_AND_KEYAcción

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.

Parámetros de entrada

keystringObligatorio
Specify the property key to find values for
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
group_type_indexintegerObligatorio
Specify the group type to find property values of

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve hedgehog configuration by uuidPOSTHOG_RETRIEVE_HEDGEHOG_CONFIGURATION_BY_UUIDAcción

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.

Parámetros de entrada

uuidstringObligatorio
Uuid

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve historical app metrics exportPOSTHOG_RETRIEVE_HISTORICAL_APP_METRICS_EXPORTAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
plugin_config_idstringObligatorio
Plugin Config Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve important project activity logPOSTHOG_RETRIEVE_IMPORTANT_PROJECT_ACTIVITY_LOGAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve insight sharing configurationsPOSTHOG_RETRIEVE_INSIGHT_SHARING_CONFIGURATIONSAcción

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.

Parámetros de entrada

insight_idintegerObligatorio
Insight Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve last viewed insights for userPOSTHOG_RETRIEVE_LAST_VIEWED_INSIGHTS_FOR_USERAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve matching events for session recordingPOSTHOG_RETRIEVE_MATCHING_EVENTS_FOR_SESSION_RECORDINGAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve notebook activity for projectPOSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_FOR_PROJECTAcción

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

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve notebook activity logPOSTHOG_RETRIEVE_NOTEBOOK_ACTIVITY_LOGAcción

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

Parámetros de entrada

short_idstringObligatorio
Short Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve notebook detailsPOSTHOG_RETRIEVE_NOTEBOOK_DETAILSAcción

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

Parámetros de entrada

short_idstringObligatorio
Short Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve or delete person retention dataPOSTHOG_RETRIEVE_OR_DELETE_PERSON_RETENTION_DATAAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve or delete project persons funnel dataPOSTHOG_RETRIEVE_OR_DELETE_PROJECT_PERSONS_FUNNEL_DATAAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization pipeline frontend app detailsPOSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_FRONTEND_APPAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization pipeline unsubscribe configsPOSTHOG_RETRIEVE_ORGANIZATION_PIPELINE_UNSUBSCRIBE_CONFIGSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization plugin activityPOSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_ACTIVITYAcción

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

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization plugin detailsPOSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization plugin repository detailsPOSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_REPOSITORY_DETAILSAcción

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

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization plugin unsubscribe configsPOSTHOG_RETRIEVE_ORGANIZATION_PLUGIN_UNSUBSCRIBE_CONFIGSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization project detailsPOSTHOG_RETRIEVE_ORGANIZATION_PROJECT_DETAILSAcción

Projects for the current organization.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this team (soon to be environment).
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization role detailsPOSTHOG_RETRIEVE_ORGANIZATION_ROLE_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this role.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Org Pipeline Repo DetailsPOSTHOG_RETRIEVE_ORGANIZATION_S_PIPELINE_REPOSITORY_DETAILSAcción

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

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve organization s unused pipeline appsPOSTHOG_RETRIEVE_ORGANIZATION_S_UNUSED_PIPELINE_APPSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve org pipeline transformation activityPOSTHOG_RETRIEVE_ORG_PIPELINE_TRANSFORMATION_ACTIVITYAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve paginated organization listPOSTHOG_RETRIEVE_PAGINATED_ORGANIZATION_LISTAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve person details by idPOSTHOG_RETRIEVE_PERSON_DETAILS_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this person.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve person details by projectPOSTHOG_RETRIEVE_PERSON_DETAILS_BY_PROJECTAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve person lifecycle detailsPOSTHOG_RETRIEVE_PERSON_LIFECYCLE_DETAILSAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve person properties timelinePOSTHOG_RETRIEVE_PERSON_PROPERTIES_TIMELINEAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this person.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve person s activity and delete optionsPOSTHOG_RETRIEVE_PERSON_S_ACTIVITY_AND_DELETE_OPTIONSAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this person.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve persons funnel correlation dataPOSTHOG_RETRIEVE_PERSONS_FUNNEL_CORRELATION_DATAAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve person values by projectPOSTHOG_RETRIEVE_PERSON_VALUES_BY_PROJECTAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline destination activityPOSTHOG_RETRIEVE_PIPELINE_DESTINATION_ACTIVITYAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline destination config detailsPOSTHOG_RETRIEVE_PIPELINE_DESTINATION_CONFIG_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline destination detailsPOSTHOG_RETRIEVE_PIPELINE_DESTINATION_DETAILSAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline destination frontend configPOSTHOG_RETRIEVE_PIPELINE_DESTINATION_FRONTEND_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline destination plugin detailsPOSTHOG_RETRIEVE_PIPELINE_DESTINATION_PLUGIN_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline frontend app activityPOSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_ACTIVITYAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline frontend app detailsPOSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline frontend app source detailsPOSTHOG_RETRIEVE_PIPELINE_FRONTEND_APP_SOURCE_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline frontend plugin configPOSTHOG_RETRIEVE_PIPELINE_FRONTEND_PLUGIN_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline import app detailsPOSTHOG_RETRIEVE_PIPELINE_IMPORT_APP_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline import apps activityPOSTHOG_RETRIEVE_PIPELINE_IMPORT_APPS_ACTIVITYAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline import app source detailsPOSTHOG_RETRIEVE_PIPELINE_IMPORT_APP_SOURCE_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline plugin details by idPOSTHOG_RETRIEVE_PIPELINE_PLUGIN_DETAILS_BY_IDAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Pipeline Plugin SourcePOSTHOG_RETRIEVE_PIPELINE_PLUGIN_SOURCEAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline transformation activityPOSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_ACTIVITYAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline transformation configPOSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pipeline transformation frontend configPOSTHOG_RETRIEVE_PIPELINE_TRANSFORMATION_FRONTEND_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin config activityPOSTHOG_RETRIEVE_PLUGIN_CONFIG_ACTIVITYAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin config activity detailsPOSTHOG_RETRIEVE_PLUGIN_CONFIG_ACTIVITY_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin config detailsPOSTHOG_RETRIEVE_PLUGIN_CONFIG_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin config frontendPOSTHOG_RETRIEVE_PLUGIN_CONFIG_FRONTENDAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin frontend configPOSTHOG_RETRIEVE_PLUGIN_FRONTEND_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin source detailsPOSTHOG_RETRIEVE_PLUGIN_SOURCE_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin update infoPOSTHOG_RETRIEVE_PLUGIN_UPDATE_INFOAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve plugin update statusPOSTHOG_RETRIEVE_PLUGIN_UPDATE_STATUSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project action details by idPOSTHOG_RETRIEVE_PROJECT_ACTION_DETAILS_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this action.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project activity detailsPOSTHOG_RETRIEVE_PROJECT_ACTIVITY_DETAILSAcción

Projects for the current organization.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this team (soon to be environment).
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project activity insightsPOSTHOG_RETRIEVE_PROJECT_ACTIVITY_INSIGHTSAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project activity log with paginationPOSTHOG_RETRIEVE_PROJECT_ACTIVITY_LOG_WITH_PAGINATIONAcción

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.

Parámetros de entrada

cursorstring
The pagination cursor value.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project annotation detailsPOSTHOG_RETRIEVE_PROJECT_ANNOTATION_DETAILSAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this annotation.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project cohort detailsPOSTHOG_RETRIEVE_PROJECT_COHORT_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this cohort.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project cohorts activity logPOSTHOG_RETRIEVE_PROJECT_COHORTS_ACTIVITY_LOGAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project cohorts with paginationPOSTHOG_RETRIEVE_PROJECT_COHORTS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
offsetinteger
The initial index from which to return the results.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project draft sql queryPOSTHOG_RETRIEVE_PROJECT_DRAFT_SQL_QUERYAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project early access feature detailsPOSTHOG_RETRIEVE_PROJECT_EARLY_ACCESS_FEATURE_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this early access feature.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project event details by idPOSTHOG_RETRIEVE_PROJECT_EVENT_DETAILS_BY_IDAcción

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.

Parámetros de entrada

idstringObligatorio
Id
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project event valuesPOSTHOG_RETRIEVE_PROJECT_EVENT_VALUESAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project experiment resultsPOSTHOG_RETRIEVE_PROJECT_EXPERIMENT_RESULTSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this experiment.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project export detailsPOSTHOG_RETRIEVE_PROJECT_EXPORT_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this exported asset.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project funnel correlation insightsPOSTHOG_RETRIEVE_PROJECT_FUNNEL_CORRELATION_INSIGHTSAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project group details by key and typePOSTHOG_RETRIEVE_PROJECT_GROUP_DETAILS_BY_KEY_AND_TYPEAcción

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.

Parámetros de entrada

group_keystringObligatorio
Specify the key of the group to find
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
group_type_indexintegerObligatorio
Specify the group type to find

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project insight activity dataPOSTHOG_RETRIEVE_PROJECT_INSIGHT_ACTIVITY_DATAAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this insight.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project insight detailsPOSTHOG_RETRIEVE_PROJECT_INSIGHT_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this insight.
formatstringenum
Format
csvjson
refreshboolean
The client can request that an insight be refreshed by setting the `refresh=true` parameter. The server will then decide if the data should or not be refreshed based on a set of heuristics meant to determine the staleness of cached data. The result will contain as `is_cached` field that indicates whether the insight was actually refreshed or not through the request.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
from_dashboardinteger
When loading an insight for a dashboard pass a `from_dashboard` query parameter containing the dashboard ID e.g. `"/api/projects/{team_id}/insights/{insight_id}?from_dashboard={dashboard_id}"` Insights can be added to more than one dashboard, this allows the insight to be loaded in the correct context. Using the correct cache and enriching the response with dashboard specific config (e.g. layouts or colors)

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project insights detailsPOSTHOG_RETRIEVE_PROJECT_INSIGHTS_DETAILSAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project insights with paginationPOSTHOG_RETRIEVE_PROJECT_INSIGHTS_WITH_PAGINATIONAcción

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.

Parámetros de entrada

limitinteger
Number of results to return per page.
formatstringenum
Format
csvjson
offsetinteger
The initial index from which to return the results.
short_idstring
Short Id
created_byinteger
Created By
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project member details by uuidPOSTHOG_RETRIEVE_PROJECT_MEMBER_DETAILS_BY_UUIDAcción

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})

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
parent__membership__user__uuidstringObligatorio
Parent Membership User Uuid

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project person activityPOSTHOG_RETRIEVE_PROJECT_PERSON_ACTIVITYAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project person cohortsPOSTHOG_RETRIEVE_PROJECT_PERSON_COHORTSAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project person stickinessPOSTHOG_RETRIEVE_PROJECT_PERSON_STICKINESSAcción

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

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project pipeline plugin configPOSTHOG_RETRIEVE_PROJECT_PIPELINE_PLUGIN_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project session valuesPOSTHOG_RETRIEVE_PROJECT_SESSION_VALUESAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project subscription detailsPOSTHOG_RETRIEVE_PROJECT_SUBSCRIPTION_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this subscription.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve project trend insightsPOSTHOG_RETRIEVE_PROJECT_TREND_INSIGHTSAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve properties and events associationPOSTHOG_RETRIEVE_PROPERTIES_AND_EVENTS_ASSOCIATIONAcción

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

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve property definition detailsPOSTHOG_RETRIEVE_PROPERTY_DEFINITION_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this property definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve proxy record detailsPOSTHOG_RETRIEVE_PROXY_RECORD_DETAILSAcción

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

Parámetros de entrada

idstringObligatorio
Id
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve related project groupsPOSTHOG_RETRIEVE_RELATED_PROJECT_GROUPSAcción

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.

Parámetros de entrada

idstringObligatorio
Specify the id of the user to find groups for
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
group_type_indexintegerObligatorio
Specify the group type to find

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

RetrieveretentioninsightsPOSTHOG_RETRIEVE_RETENTION_INSIGHTSAcción

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.

Parámetros de entrada

formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve session property definitionsPOSTHOG_RETRIEVE_SESSION_PROPERTY_DEFINITIONSAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve session recording detailsPOSTHOG_RETRIEVE_SESSION_RECORDING_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this session recording.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve session recording error clustersPOSTHOG_RETRIEVE_SESSION_RECORDING_ERROR_CLUSTERSAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve session recording playlist detailsPOSTHOG_RETRIEVE_SESSION_RECORDING_PLAYLIST_DETAILSAcción

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/`.

Parámetros de entrada

short_idstringObligatorio
Short Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve session recording propertiesPOSTHOG_RETRIEVE_SESSION_RECORDING_PROPERTIES_BY_PROJECT_IDAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve session recording snapshotsPOSTHOG_RETRIEVE_SESSION_RECORDING_SNAPSHOTSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this session recording.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve similar session recordingsPOSTHOG_RETRIEVE_SIMILAR_SESSION_RECORDINGSAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this session recording.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve specific batch export detailsPOSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve specific batch export run detailsPOSTHOG_RETRIEVE_SPECIFIC_BATCH_EXPORT_RUN_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this batch export run.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
batch_export_idstringObligatorio
Batch Export Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve specific domain detailsPOSTHOG_RETRIEVE_SPECIFIC_DOMAIN_DETAILSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this domain.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve specific exported asset contentPOSTHOG_RETRIEVE_SPECIFIC_EXPORTED_ASSET_CONTENTAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this exported asset.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve specific historical plugin exportPOSTHOG_RETRIEVE_SPECIFIC_HISTORICAL_PLUGIN_EXPORTAcción

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.

Parámetros de entrada

idstringObligatorio
Id
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
plugin_config_idstringObligatorio
Plugin Config Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

RetrievespecificpipelinefrontendappconfigPOSTHOG_RETRIEVE_SPECIFIC_PIPELINE_FRONTEND_APP_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this plugin config.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve specific project dashboard detailsPOSTHOG_RETRIEVE_SPECIFIC_PROJECT_DASHBOARD_DETAILSAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this dashboard.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve survey activity logsPOSTHOG_RETRIEVE_SURVEY_ACTIVITY_LOGSAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this survey.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve survey details with uuid and project idPOSTHOG_RETRIEVE_SURVEY_DETAILS_WITH_UUID_AND_PROJECT_IDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this survey.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve survey responses count by project idPOSTHOG_RETRIEVE_SURVEY_RESPONSES_COUNT_BY_PROJECT_IDAcción

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.

Parámetros de entrada

project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve unsubscribed pipeline configsPOSTHOG_RETRIEVE_UNSUBSCRIBED_PIPELINE_CONFIGSAcción

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

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve unused organization pluginsPOSTHOG_RETRIEVE_UNUSED_ORGANIZATION_PLUGINSAcción

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.

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

RetrieveunusedpipelinedestinationsPOSTHOG_RETRIEVE_UNUSED_PIPELINE_DESTINATIONSAcción

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

Parámetros de entrada

organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve user details for initiating 2fa setupPOSTHOG_RETRIEVE_USER_DETAILS_FOR_INITIATING2_FA_SETUPAcción

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.

Parámetros de entrada

uuidstringObligatorio
Uuid

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve user profile and team detailsPOSTHOG_RETRIEVE_USER_PROFILE_AND_TEAM_DETAILSAcción

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

Parámetros de entrada

uuidstringObligatorio
Uuid

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Revoke organization invitePOSTHOG_REVOKE_ORGANIZATION_INVITEAcción

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

Parámetros de entrada

idstringObligatorio
A UUID string identifying this organization invite.
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set insight deletion flagPOSTHOG_SET_INSIGHT_DELETION_FLAGAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this insight.
formatstringenum
Format
csvjson
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Soft delete a specific cohort by idPOSTHOG_SOFT_DELETE_A_SPECIFIC_COHORT_BY_IDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this cohort.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Soft delete feature flag by setting statusPOSTHOG_SOFT_DELETE_FEATURE_FLAG_BY_SETTING_STATUSAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this feature flag.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Soft delete project dashboardPOSTHOG_SOFT_DELETE_PROJECT_DASHBOARDAcción

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

Parámetros de entrada

idintegerObligatorio
A unique integer value identifying this dashboard.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Split person entities in projectPOSTHOG_SPLIT_PERSON_ENTITIES_IN_PROJECTAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
uuidstringObligatoriouuid
Uuid
formatstringenum
Format
csvjson
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]Obligatorio
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Trigger project export with format optionPOSTHOG_TRIGGER_PROJECT_EXPORT_WITH_FORMAT_OPTIONAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
insightinteger
Insight
filenamestringObligatorio
Filename
dashboardinteger
Dashboard
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
has_contentstringObligatorio
Has Content
expires_afterstringdate-time
Expires After
export_formatstringObligatorioenum
* `image/png` - image/png * `application/pdf` - application/pdf * `text/csv` - text/csv * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
image/pngapplication/pdftext/csvapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet
export_contextany
Export Context

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update annotation detailsPOSTHOG_UPDATE_ANNOTATION_DETAILSAcción

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

Parámetros de entrada

idintegerObligatorio
Id
scopestringenum
* `dashboard_item` - insight * `dashboard` - dashboard * `project` - project * `organization` - organization
dashboard_itemdashboardprojectorganization
contentstring
Content
deletedboolean
Deleted
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
date_markerstringdate-time
Date Marker
dashboard_idintegerObligatorio
Dashboard Id
insight_namestringObligatorio
Insight Name
creation_typestringenum
* `USR` - user * `GIT` - GitHub
USRGIT
dashboard_iteminteger
Dashboard Item
dashboard_namestringObligatorio
Dashboard Name
insight_short_idstringObligatorio
Insight Short Id
insight_derived_namestringObligatorio
Insight Derived Name

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update early access project featurePOSTHOG_UPDATE_EARLY_ACCESS_PROJECT_FEATUREAcción

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

Parámetros de entrada

idstringObligatoriouuid
Id
namestring
Name
stagestringenum
* `draft` - draft * `concept` - concept * `alpha` - alpha * `beta` - beta * `general-availability` - general availability * `archived` - archived
draftconceptalphabetageneral-availabilityarchived
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
documentation_urlstringuri
Documentation Url

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update event definition by uuidPOSTHOG_UPDATE_EVENT_DEFINITION_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this event definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update experiment detailsPOSTHOG_UPDATE_EXPERIMENT_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
filtersany
Filters
archivedboolean
Archived
end_datestringdate-time
End Date
created_atstringObligatoriodate-time
Created At
parametersany
Parameters
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
exposure_cohortintegerObligatorio
Exposure Cohort
feature_flag_keystringObligatorio
Feature Flag Key
secondary_metricsany
Secondary Metrics

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update feature flag configurationPOSTHOG_UPDATE_FEATURE_FLAG_CONFIGURATIONAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
keystringObligatorio
Key
namestring
contains the description for the flag (field name `name` is kept for backwards-compatibility)
tagsarray
Tags
activeboolean
Active
deletedboolean
Deleted
filtersobject
Filters
surveysobjectObligatorio
Surveys
can_editbooleanObligatorio
Can Edit
featuresobjectObligatorio
Features
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
experiment_setinteger[]Obligatorio
Experiment Set
is_simple_flagbooleanObligatorio
Is Simple Flag
usage_dashboardintegerObligatorio
Usage Dashboard
performed_rollbackboolean
Performed Rollback
rollout_percentageintegerObligatorio
Rollout Percentage
rollback_conditionsany
Rollback Conditions
analytics_dashboardsinteger[]
Analytics Dashboards
has_enriched_analyticsboolean
Has Enriched Analytics
ensure_experience_continuityboolean
Ensure Experience Continuity

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update organization details by uuidPOSTHOG_UPDATE_ORGANIZATION_DETAILS_BY_UUIDAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestring
Name
slugstring
Slug
teamsobject[]
Teams
metadatastring
Metadata
created_atstringdate-time
Created At
updated_atstringdate-time
Updated At
customer_idstring
Customer Id
enforce_2faboolean
Enforce 2Fa
member_countstring
Member Count
available_product_featuresarray
Available Product Features
is_member_join_email_enabledboolean
Is Member Join Email Enabled

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update organization domain info and saml configPOSTHOG_UPDATE_ORGANIZATION_DOMAIN_INFO_AND_SAML_CONFIGAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
domainstringObligatorio
Domain
has_samlbooleanObligatorio
Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places).
is_verifiedbooleanObligatorio
Determines whether a domain is verified or not.
verified_atstringObligatoriodate-time
Verified At
saml_acs_urlstring
Saml Acs Url
saml_entity_idstring
Saml Entity Id
saml_x509_certstring
Saml X509 Cert
organization_idstringObligatorio
Organization Id
sso_enforcementstring
Sso Enforcement
verification_challengestringObligatorio
Verification Challenge
jit_provisioning_enabledboolean
Jit Provisioning Enabled

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update organization domain propertiesPOSTHOG_UPDATE_ORGANIZATION_DOMAIN_PROPERTIESAcción

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

Parámetros de entrada

idstringObligatoriouuid
Id
domainstring
Domain
has_samlboolean
Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places).
is_verifiedboolean
Determines whether a domain is verified or not.
verified_atstringdate-time
Verified At
saml_acs_urlstring
Saml Acs Url
saml_entity_idstring
Saml Entity Id
saml_x509_certstring
Saml X509 Cert
organization_idstringObligatorio
Organization Id
sso_enforcementstring
Sso Enforcement
verification_challengestring
Verification Challenge
jit_provisioning_enabledboolean
Jit Provisioning Enabled

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update organization member by uuidsPOSTHOG_UPDATE_ORGANIZATION_MEMBER_BY_UUIDSAcción

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

Parámetros de entrada

idstringuuid
Id
joined_atstringdate-time
Joined At
updated_atstringdate-time
Updated At
user__uuidstringObligatorio
User Uuid
is_2fa_enabledboolean
Is 2Fa Enabled
has_social_authboolean
Has Social Auth
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update organization member detailsPOSTHOG_UPDATE_ORGANIZATION_MEMBER_DETAILSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
joined_atstringObligatoriodate-time
Joined At
updated_atstringObligatoriodate-time
Updated At
user__uuidstringObligatorio
User Uuid
is_2fa_enabledbooleanObligatorio
Is 2Fa Enabled
has_social_authbooleanObligatorio
Has Social Auth
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update organization s proxy record domainPOSTHOG_UPDATE_ORGANIZATION_S_PROXY_RECORD_DOMAINAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
domainstringObligatorio
Domain
messagestringObligatorio
Message
created_atstringObligatoriodate-time
Created At
created_byintegerObligatorio
Created By
updated_atstringObligatoriodate-time
Updated At
target_cnamestringObligatorio
Target Cname
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update partial project cohort detailsPOSTHOG_UPDATE_PARTIAL_PROJECT_COHORT_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
countinteger
Count
queryany
Query
groupsany
Groups
deletedboolean
Deleted
filtersany
Filters
is_staticboolean
Is Static
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
experiment_setinteger[]
Experiment Set
is_calculatingboolean
Is Calculating
last_calculationstringdate-time
Last Calculation
errors_calculatinginteger
Errors Calculating

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update partial role details in organizationPOSTHOG_UPDATE_PARTIAL_ROLE_DETAILS_IN_ORGANIZATIONAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestring
Name
membersstring
Members
created_atstringdate-time
Created At
organization_idstringObligatorio
Organization Id
associated_flagsstring
Associated Flags

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update partial subscription detailsPOSTHOG_UPDATE_PARTIAL_SUBSCRIPTION_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
countinteger
Count
titlestring
Title
deletedboolean
Deleted
insightinteger
Insight
summarystring
Summary
bysetposinteger
Bysetpos
intervalinteger
Interval
byweekdaystring[]
Byweekday
dashboardinteger
Dashboard
frequencystringenum
* `daily` - Daily * `weekly` - Weekly * `monthly` - Monthly * `yearly` - Yearly
dailyweeklymonthlyyearly
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
until_datestringdate-time
Until Date
target_typestringenum
* `email` - Email * `slack` - Slack * `webhook` - Webhook
emailslackwebhook
target_valuestring
Target Value
invite_messagestring
Invite Message
next_delivery_datestringdate-time
Next Delivery Date

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update partial survey detailsPOSTHOG_UPDATE_PARTIAL_SURVEY_DETAILSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestring
Name
typestringenum
* `popover` - popover * `widget` - widget * `button` - button * `email` - email * `full_screen` - full screen * `api` - api
popoverwidgetbuttonemailfull_screenapi
archivedboolean
Archived
end_datestringdate-time
End Date
questionsany
The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice. Basic (open-ended question) - `type`: `open` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `branching`: Branching logic for the question. See branching types below for details. Link (a question with a link) - `type`: `link` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `link`: The URL associated with the question. - `branching`: Branching logic for the question. See branching types below for details. Rating (a question with a rating scale) - `type`: `rating` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `display`: Display style of the rating (`number` or `emoji`). - `scale`: The scale of the rating (`number`). - `lowerBoundLabel`: Label for the lower bound of the scale. - `upperBoundLabel`: Label for the upper bound of the scale. - `branching`: Branching logic for the question. See branching types below for details. Multiple choice - `type`: `single_choice` or `multiple_choice` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `choices`: An array of choices for the question. - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`). - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`). - `branching`: Branching logic for the question. See branching types below for details. Branching logic can be one of the following types: Next question: Proceeds to the next question ```json { "type": "next_question" } ``` End: Ends the survey, optionally displaying a confirmation message. ```json { "type": "end" } ``` Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types. ```json { "type": "response_based", "responseValues": { "responseKey": "value" } } ``` Specific question: Proceeds to a specific question by index. ```json { "type": "specific_question", "index": 2 } ```
appearanceany
Appearance
conditionsany
Conditions
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
descriptionstring
Description
linked_flag_idinteger
Linked Flag Id
iteration_countinteger
Iteration Count
responses_limitinteger
Responses Limit
current_iterationinteger
Current Iteration
targeting_flag_idinteger
Targeting Flag Id
iteration_start_datesstring[]
Iteration Start Dates
remove_targeting_flagboolean
Remove Targeting Flag
targeting_flag_filtersany
Targeting Flag Filters
iteration_frequency_daysinteger
Iteration Frequency Days
current_iteration_start_datestringdate-time
Current Iteration Start Date

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update person propertiesPOSTHOG_UPDATE_PERSON_PROPERTIESAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestringObligatorio
Name
uuidstringObligatoriouuid
Uuid
formatstringenum
Format
csvjson
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]Obligatorio
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update person property endpointPOSTHOG_UPDATE_PERSON_PROPERTY_ENDPOINTAcción

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

Parámetros de entrada

idintegerObligatorio
Id
keystringObligatorio
Specify the property key
namestringObligatorio
Name
uuidstringObligatoriouuid
Uuid
valueanyObligatorio
Specify the property value
formatstringenum
Format
csvjson
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
propertiesany
Properties
distinct_idsstring[]Obligatorio
Distinct Ids

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update pipeline destination configPOSTHOG_UPDATE_PIPELINE_DESTINATION_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update pipeline frontend app configPOSTHOG_UPDATE_PIPELINE_FRONTEND_APP_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update pipeline plugin configPOSTHOG_UPDATE_PIPELINE_PLUGIN_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update pipeline transformation configPOSTHOG_UPDATE_PIPELINE_TRANSFORMATION_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update plugin config for projectPOSTHOG_UPDATE_PLUGIN_CONFIG_FOR_PROJECTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project action by idPOSTHOG_UPDATE_PROJECT_ACTION_BY_IDAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
stepsobject[]
Steps
formatstringenum
Format
csvjson
deletedboolean
Deleted
team_idintegerObligatorio
Team Id
is_actionboolean
Is Action
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
post_to_slackboolean
Post To Slack
bytecode_errorstringObligatorio
Bytecode Error
is_calculatingbooleanObligatorio
Is Calculating
last_calculated_atstringdate-time
Last Calculated At
slack_message_formatstring
Slack Message Format

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project action with partial dataPOSTHOG_UPDATE_PROJECT_ACTION_WITH_PARTIAL_DATAAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
stepsobject[]
Steps
formatstringenum
Format
csvjson
deletedboolean
Deleted
team_idinteger
Team Id
is_actionboolean
Is Action
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
post_to_slackboolean
Post To Slack
bytecode_errorstring
Bytecode Error
is_calculatingboolean
Is Calculating
last_calculated_atstringdate-time
Last Calculated At
slack_message_formatstring
Slack Message Format

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project cohort detailsPOSTHOG_UPDATE_PROJECT_COHORT_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
countintegerObligatorio
Count
queryany
Query
groupsany
Groups
deletedboolean
Deleted
filtersany
Filters
is_staticboolean
Is Static
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
experiment_setinteger[]Obligatorio
Experiment Set
is_calculatingbooleanObligatorio
Is Calculating
last_calculationstringObligatoriodate-time
Last Calculation
errors_calculatingintegerObligatorio
Errors Calculating

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project dashboard detailsPOSTHOG_UPDATE_PROJECT_DASHBOARD_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
tilesobject[]Obligatorio
Tiles
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
is_sharedbooleanObligatorio
Is Shared
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
use_templatestring
Use Template
use_dashboardinteger
Use Dashboard
delete_insightsboolean
Delete Insights

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project early access featurePOSTHOG_UPDATE_PROJECT_EARLY_ACCESS_FEATUREAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
stagestringObligatorioenum
* `draft` - draft * `concept` - concept * `alpha` - alpha * `beta` - beta * `general-availability` - general availability * `archived` - archived
draftconceptalphabetageneral-availabilityarchived
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
documentation_urlstringuri
Documentation Url

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project event definitionPOSTHOG_UPDATE_PROJECT_EVENT_DEFINITIONAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this event definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project group type metadataPOSTHOG_UPDATE_PROJECT_GROUP_TYPE_METADATAAcción

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.

Parámetros de entrada

group_typestring
Group Type
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
name_pluralstring
Name Plural
name_singularstring
Name Singular
group_type_indexinteger
Group Type Index

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project insight detailsPOSTHOG_UPDATE_PROJECT_INSIGHT_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
tagsarray
Tags
hogqlstringObligatorio
Hogql
orderinteger
Order
queryany
Query node JSON string
savedboolean
Saved
typesstringObligatorio
Types
formatstringenum
Format
csvjson
resultstringObligatorio
Result
columnsstringObligatorio
Columns
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
timezonestringObligatorio
The timezone this chart is displayed in.
favoritedboolean
Favorited
is_cachedstringObligatorio
Is Cached
is_samplebooleanObligatorio
Is Sample
created_atstringObligatoriodate-time
Created At
dashboardsinteger[]
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
derived_namestring
Derived Name
last_refreshstringObligatorio
The datetime this insight"s results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).
query_statusstringObligatorio
Query Status
dashboard_tilesobject[]Obligatorio
A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.
cache_target_agestringObligatorio
The target age of the cached results for this insight.
last_modified_atstringObligatoriodate-time
Last Modified At
next_allowed_client_refreshstringObligatorio
The earliest possible datetime at which we"ll allow the cached results for this insight to be refreshed by querying the database.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project member role by uuidPOSTHOG_UPDATE_PROJECT_MEMBER_ROLE_BY_UUIDAcción

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.

Parámetros de entrada

idstringuuid
Id
joined_atstringdate-time
Joined At
user_uuidstringuuid
User Uuid
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
parent_levelinteger
Parent Level
parent_membership_idstringuuid
Parent Membership Id
parent__membership__user__uuidstringObligatorio
Parent Membership User Uuid

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project member s role by uuidPOSTHOG_UPDATE_PROJECT_MEMBER_S_ROLE_BY_UUIDAcción

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

Parámetros de entrada

idstringObligatoriouuid
Id
joined_atstringObligatoriodate-time
Joined At
user_uuidstringObligatoriouuid
User Uuid
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
parent_levelintegerObligatorio
Parent Level
parent_membership_idstringObligatoriouuid
Parent Membership Id
parent__membership__user__uuidstringObligatorio
Parent Membership User Uuid

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project notebook detailsPOSTHOG_UPDATE_PROJECT_NOTEBOOK_DETAILSAcción

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

Parámetros de entrada

idstringObligatoriouuid
Id
titlestring
Title
contentany
Content
deletedboolean
Deleted
versioninteger
Version
short_idstringObligatorio
Short Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
text_contentstring
Text Content
last_modified_atstringObligatoriodate-time
Last Modified At

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project pipeline destination configPOSTHOG_UPDATE_PROJECT_PIPELINE_DESTINATION_CONFIGAcción

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

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project pipeline transformation configPOSTHOG_UPDATE_PROJECT_PIPELINE_TRANSFORMATION_CONFIGAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstring
Error
orderinteger
Order
configstring
Config
plugininteger
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idinteger
Team Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringdate-time
Updated At
descriptionstring
Description
plugin_infostring
Plugin Info
delivery_rate_24hstring
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project plugin configurationPOSTHOG_UPDATE_PROJECT_PLUGIN_CONFIGURATIONAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
errorstringObligatorio
Error
orderintegerObligatorio
Order
configstringObligatorio
Config
pluginintegerObligatorio
Plugin
deletedboolean
Deleted
enabledboolean
Enabled
filtersany
Filters
team_idintegerObligatorio
Team Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
updated_atstringObligatoriodate-time
Updated At
descriptionstring
Description
plugin_infostringObligatorio
Plugin Info
delivery_rate_24hstringObligatorio
Delivery Rate 24H

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project property definitionPOSTHOG_UPDATE_PROJECT_PROPERTY_DEFINITIONAcción

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.

Parámetros de entrada

idstringObligatorio
A UUID string identifying this property definition.
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project session recording playlistPOSTHOG_UPDATE_PROJECT_SESSION_RECORDING_PLAYLISTAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
namestring
Name
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
derived_namestring
Derived Name
last_modified_atstringObligatoriodate-time
Last Modified At

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project subscription detailsPOSTHOG_UPDATE_PROJECT_SUBSCRIPTION_DETAILSAcción

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.

Parámetros de entrada

idintegerObligatorio
Id
countinteger
Count
titlestring
Title
deletedboolean
Deleted
insightinteger
Insight
summarystringObligatorio
Summary
bysetposinteger
Bysetpos
intervalinteger
Interval
byweekdaystring[]
Byweekday
dashboardinteger
Dashboard
frequencystringObligatorioenum
* `daily` - Daily * `weekly` - Weekly * `monthly` - Monthly * `yearly` - Yearly
dailyweeklymonthlyyearly
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringObligatoriodate-time
Start Date
until_datestringdate-time
Until Date
target_typestringObligatorioenum
* `email` - Email * `slack` - Slack * `webhook` - Webhook
emailslackwebhook
target_valuestringObligatorio
Target Value
invite_messagestring
Invite Message
next_delivery_datestringObligatoriodate-time
Next Delivery Date

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update project survey detailsPOSTHOG_UPDATE_PROJECT_SURVEY_DETAILSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
typestringObligatorioenum
* `popover` - popover * `widget` - widget * `button` - button * `email` - email * `full_screen` - full screen * `api` - api
popoverwidgetbuttonemailfull_screenapi
archivedboolean
Archived
end_datestringdate-time
End Date
questionsany
The `array` of questions included in the survey. Each question must conform to one of the defined question types: Basic, Link, Rating, or Multiple Choice. Basic (open-ended question) - `type`: `open` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `branching`: Branching logic for the question. See branching types below for details. Link (a question with a link) - `type`: `link` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `link`: The URL associated with the question. - `branching`: Branching logic for the question. See branching types below for details. Rating (a question with a rating scale) - `type`: `rating` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `display`: Display style of the rating (`number` or `emoji`). - `scale`: The scale of the rating (`number`). - `lowerBoundLabel`: Label for the lower bound of the scale. - `upperBoundLabel`: Label for the upper bound of the scale. - `branching`: Branching logic for the question. See branching types below for details. Multiple choice - `type`: `single_choice` or `multiple_choice` - `question`: The text of the question. - `description`: Optional description of the question. - `descriptionContentType`: Content type of the description (`html` or `text`). - `optional`: Whether the question is optional (`boolean`). - `buttonText`: Text displayed on the submit button. - `choices`: An array of choices for the question. - `shuffleOptions`: Whether to shuffle the order of the choices (`boolean`). - `hasOpenChoice`: Whether the question allows an open-ended response (`boolean`). - `branching`: Branching logic for the question. See branching types below for details. Branching logic can be one of the following types: Next question: Proceeds to the next question ```json { "type": "next_question" } ``` End: Ends the survey, optionally displaying a confirmation message. ```json { "type": "end" } ``` Response-based: Branches based on the response values. Available for the `rating` and `single_choice` question types. ```json { "type": "response_based", "responseValues": { "responseKey": "value" } } ``` Specific question: Proceeds to a specific question by index. ```json { "type": "specific_question", "index": 2 } ```
appearanceany
Appearance
conditionsstringObligatorio
Conditions
created_atstringObligatoriodate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
start_datestringdate-time
Start Date
descriptionstring
Description
linked_flag_idinteger
Linked Flag Id
iteration_countinteger
Iteration Count
responses_limitinteger
Responses Limit
current_iterationinteger
Current Iteration
iteration_start_datesstring[]
Iteration Start Dates
iteration_frequency_daysinteger
Iteration Frequency Days
current_iteration_start_datestringdate-time
Current Iteration Start Date

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update role details in organizationPOSTHOG_UPDATE_ROLE_DETAILS_IN_ORGANIZATIONAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
namestringObligatorio
Name
membersstringObligatorio
Members
created_atstringObligatoriodate-time
Created At
organization_idstringObligatorio
Organization Id
associated_flagsstringObligatorio
Associated Flags

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update session recording playlist partiallyPOSTHOG_UPDATE_SESSION_RECORDING_PLAYLIST_PARTIALLYAcción

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.

Parámetros de entrada

idinteger
Id
namestring
Name
pinnedboolean
Pinned
deletedboolean
Deleted
filtersany
Filters
short_idstringObligatorio
Short Id
created_atstringdate-time
Created At
project_idstringObligatorio
Project ID of the project you"re trying to access. To find the ID of the project, make a call to /api/projects/.
descriptionstring
Description
derived_namestring
Derived Name
last_modified_atstringdate-time
Last Modified At

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update specific proxy record fieldsPOSTHOG_UPDATE_SPECIFIC_PROXY_RECORD_FIELDSAcción

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.

Parámetros de entrada

idstringObligatoriouuid
Id
domainstring
Domain
messagestring
Message
created_atstringdate-time
Created At
created_byinteger
Created By
updated_atstringdate-time
Updated At
target_cnamestring
Target Cname
organization_idstringObligatorio
Organization Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not