openapi.city
Sign in

PostHog

Open source product analytics

posthog.com/docs/api ↗
Version
1.0.0
OpenAPI
3.0.3
Endpoints
388
Schemas
380
52
Quality
Updated
3 days ago
Analytics analytics product open-source
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://app.posthog.com
https://eu.posthog.com

Endpoints

Clear filters
GET POST PUT PATCH DELETE

Actions 1 endpoints

PATCH /api/projects/{project_id}/actions/{id}
operationId: Actions_updateById

Parameters

Name In Required Type Description
format query optional string —
id path required integer

A unique integer value identifying this action.
project_id path required string

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

Request Body

application/json
schema PatchedAction
Property Type Required
id integer optional
name string optional
tags array optional
steps array optional
└ id string optional
└ url string optional
└ href string optional
└ name string optional
└ text string optional
└ event string optional
└ selector string optional
└ tag_name string optional
└ properties object optional
└ url_matching object optional
└ href_matching object optional
└ text_matching object optional
deleted boolean optional
team_id integer optional
is_action boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
post_to_slack boolean optional
bytecode_error string optional
is_calculating boolean optional
last_calculated_at string optional
slack_message_format string optional
multipart/form-data
schema PatchedAction
Property Type Required
id integer optional
name string optional
tags array optional
steps array optional
└ id string optional
└ url string optional
└ href string optional
└ name string optional
└ text string optional
└ event string optional
└ selector string optional
└ tag_name string optional
└ properties object optional
└ url_matching object optional
└ href_matching object optional
└ text_matching object optional
deleted boolean optional
team_id integer optional
is_action boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
post_to_slack boolean optional
bytecode_error string optional
is_calculating boolean optional
last_calculated_at string optional
slack_message_format string optional
application/x-www-form-urlencoded
schema PatchedAction
Property Type Required
id integer optional
name string optional
tags array optional
steps array optional
└ id string optional
└ url string optional
└ href string optional
└ name string optional
└ text string optional
└ event string optional
└ selector string optional
└ tag_name string optional
└ properties object optional
└ url_matching object optional
└ href_matching object optional
└ text_matching object optional
deleted boolean optional
team_id integer optional
is_action boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
post_to_slack boolean optional
bytecode_error string optional
is_calculating boolean optional
last_calculated_at string optional
slack_message_format string optional

Responses

200 —
PATCH /api/projects/{project_id}/actions/{id}

Annotations 1 endpoints

PATCH /api/projects/{project_id}/annotations/{id}

Create, Read, Update and Delete annotations. See docs for more information on annotations.

operationId: Annotations_crudById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this annotation.
project_id path required string

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

Request Body

application/json
schema PatchedAnnotation
Property Type Required
id integer optional
scope string optional
content string optional
deleted boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
updated_at string optional
date_marker string optional
insight_name string optional
creation_type string optional
dashboard_item integer optional
insight_short_id string optional
multipart/form-data
schema PatchedAnnotation
Property Type Required
id integer optional
scope string optional
content string optional
deleted boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
updated_at string optional
date_marker string optional
insight_name string optional
creation_type string optional
dashboard_item integer optional
insight_short_id string optional
application/x-www-form-urlencoded
schema PatchedAnnotation
Property Type Required
id integer optional
scope string optional
content string optional
deleted boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
updated_at string optional
date_marker string optional
insight_name string optional
creation_type string optional
dashboard_item integer optional
insight_short_id string optional

Responses

200 —
PATCH /api/projects/{project_id}/annotations/{id}

Batchexports 1 endpoints

PATCH /api/projects/{project_id}/batch_exports/{id}
operationId: Batchexports_updateByIdPatch

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
project_id path required string

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

Request Body

application/json
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
└ type string required
└ config object optional
hogql_query string optional
latest_runs array optional
└ id string required
└ cursor string optional
└ status string required
└ created_at string required
└ finished_at string optional
└ batch_export string required
└ latest_error string optional
└ last_updated_at string required
└ data_interval_end string required
└ records_completed integer optional
└ data_interval_start string required
└ records_total_count integer optional
last_paused_at string optional
last_updated_at string optional
multipart/form-data
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
└ type string required
└ config object optional
hogql_query string optional
latest_runs array optional
└ id string required
└ cursor string optional
└ status string required
└ created_at string required
└ finished_at string optional
└ batch_export string required
└ latest_error string optional
└ last_updated_at string required
└ data_interval_end string required
└ records_completed integer optional
└ data_interval_start string required
└ records_total_count integer optional
last_paused_at string optional
last_updated_at string optional
application/x-www-form-urlencoded
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
└ type string required
└ config object optional
hogql_query string optional
latest_runs array optional
└ id string required
└ cursor string optional
└ status string required
└ created_at string required
└ finished_at string optional
└ batch_export string required
└ latest_error string optional
└ last_updated_at string required
└ data_interval_end string required
└ records_completed integer optional
└ data_interval_start string required
└ records_total_count integer optional
last_paused_at string optional
last_updated_at string optional

Responses

200 —
PATCH /api/projects/{project_id}/batch_exports/{id}

Cohorts 1 endpoints

PATCH /api/projects/{project_id}/cohorts/{id}
operationId: Cohorts_updateDetails

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this cohort.
project_id path required string

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

Request Body

application/json
schema PatchedCohort
Property Type Required
id integer optional
name string optional
count integer optional
query object optional
groups object optional
deleted boolean optional
filters object optional
is_static boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
is_calculating boolean optional
last_calculation string optional
errors_calculating integer optional
multipart/form-data
schema PatchedCohort
Property Type Required
id integer optional
name string optional
count integer optional
query object optional
groups object optional
deleted boolean optional
filters object optional
is_static boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
is_calculating boolean optional
last_calculation string optional
errors_calculating integer optional
application/x-www-form-urlencoded
schema PatchedCohort
Property Type Required
id integer optional
name string optional
count integer optional
query object optional
groups object optional
deleted boolean optional
filters object optional
is_static boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
is_calculating boolean optional
last_calculation string optional
errors_calculating integer optional

Responses

200 —
PATCH /api/projects/{project_id}/cohorts/{id}

Dashboardtemplates 1 endpoints

PATCH /api/projects/{project_id}/dashboard_templates/{id}
operationId: Dashboardtemplates_updateByIdPatch

Parameters

Name In Required Type Description
id path required string —
project_id path required string

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

Request Body

application/json
schema PatchedDashboardTemplate
Property Type Required
id string optional
tags array optional
scope object optional
tiles object optional
deleted boolean optional
team_id integer optional
image_url string optional
variables object optional
created_at string optional
created_by integer optional
template_name string optional
dashboard_filters object optional
dashboard_description string optional
multipart/form-data
schema PatchedDashboardTemplate
Property Type Required
id string optional
tags array optional
scope object optional
tiles object optional
deleted boolean optional
team_id integer optional
image_url string optional
variables object optional
created_at string optional
created_by integer optional
template_name string optional
dashboard_filters object optional
dashboard_description string optional
application/x-www-form-urlencoded
schema PatchedDashboardTemplate
Property Type Required
id string optional
tags array optional
scope object optional
tiles object optional
deleted boolean optional
team_id integer optional
image_url string optional
variables object optional
created_at string optional
created_by integer optional
template_name string optional
dashboard_filters object optional
dashboard_description string optional

Responses

200 —
PATCH /api/projects/{project_id}/dashboard_templates/{id}

Dashboards 2 endpoints

PATCH /api/projects/{project_id}/dashboards/{id}
operationId: Dashboards_updateById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this dashboard.
project_id path required string

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

Request Body

application/json
schema PatchedDashboard
Property Type Required
id integer optional
name string optional
tags array optional
tiles array optional
pinned boolean optional
deleted boolean optional
filters object optional
is_shared boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
use_template string optional
creation_mode string optional
use_dashboard integer optional
delete_insights boolean optional
restriction_level integer optional
effective_privilege_level integer optional
effective_restriction_level integer optional
multipart/form-data
schema PatchedDashboard
Property Type Required
id integer optional
name string optional
tags array optional
tiles array optional
pinned boolean optional
deleted boolean optional
filters object optional
is_shared boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
use_template string optional
creation_mode string optional
use_dashboard integer optional
delete_insights boolean optional
restriction_level integer optional
effective_privilege_level integer optional
effective_restriction_level integer optional
application/x-www-form-urlencoded
schema PatchedDashboard
Property Type Required
id integer optional
name string optional
tags array optional
tiles array optional
pinned boolean optional
deleted boolean optional
filters object optional
is_shared boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
use_template string optional
creation_mode string optional
use_dashboard integer optional
delete_insights boolean optional
restriction_level integer optional
effective_privilege_level integer optional
effective_restriction_level integer optional

Responses

200 —
PATCH /api/projects/{project_id}/dashboards/{id}
PATCH /api/projects/{project_id}/dashboards/{id}/move_tile
operationId: Dashboards_moveTilePatch

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this dashboard.
project_id path required string

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

Request Body

application/json
schema PatchedDashboard
Property Type Required
id integer optional
name string optional
tags array optional
tiles array optional
pinned boolean optional
deleted boolean optional
filters object optional
is_shared boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
use_template string optional
creation_mode string optional
use_dashboard integer optional
delete_insights boolean optional
restriction_level integer optional
effective_privilege_level integer optional
effective_restriction_level integer optional
multipart/form-data
schema PatchedDashboard
Property Type Required
id integer optional
name string optional
tags array optional
tiles array optional
pinned boolean optional
deleted boolean optional
filters object optional
is_shared boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
use_template string optional
creation_mode string optional
use_dashboard integer optional
delete_insights boolean optional
restriction_level integer optional
effective_privilege_level integer optional
effective_restriction_level integer optional
application/x-www-form-urlencoded
schema PatchedDashboard
Property Type Required
id integer optional
name string optional
tags array optional
tiles array optional
pinned boolean optional
deleted boolean optional
filters object optional
is_shared boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
use_template string optional
creation_mode string optional
use_dashboard integer optional
delete_insights boolean optional
restriction_level integer optional
effective_privilege_level integer optional
effective_restriction_level integer optional

Responses

200 —
PATCH /api/projects/{project_id}/dashboards/{id}/move_tile

Earlyaccessfeature 1 endpoints

PATCH /api/projects/{project_id}/early_access_feature/{id}
operationId: Earlyaccessfeature_updateContent

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this early access feature.
project_id path required string

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

Request Body

application/json
schema PatchedEarlyAccessFeature
Property Type Required
id string optional
name string optional
stage string optional
created_at string optional
description string optional
feature_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
documentation_url string optional
multipart/form-data
schema PatchedEarlyAccessFeature
Property Type Required
id string optional
name string optional
stage string optional
created_at string optional
description string optional
feature_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
documentation_url string optional
application/x-www-form-urlencoded
schema PatchedEarlyAccessFeature
Property Type Required
id string optional
name string optional
stage string optional
created_at string optional
description string optional
feature_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
documentation_url string optional

Responses

200 —
PATCH /api/projects/{project_id}/early_access_feature/{id}

Eventdefinitions 1 endpoints

PATCH /api/projects/{project_id}/event_definitions/{id}
operationId: Eventdefinitions_updateByIdPatch

Parameters

Name In Required Type Description
id path required string —
project_id path required string

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

Responses

200

No response body
PATCH /api/projects/{project_id}/event_definitions/{id}

Experiments 1 endpoints

PATCH /api/projects/{project_id}/experiments/{id}
operationId: Experiments_updateExperimentById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this experiment.
project_id path required string

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

Request Body

application/json
schema PatchedExperiment
Property Type Required
id integer optional
name string optional
filters object optional
archived boolean optional
end_date string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
parameters object optional
start_date string optional
updated_at string optional
description string optional
feature_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
feature_flag_key string optional
secondary_metrics object optional
multipart/form-data
schema PatchedExperiment
Property Type Required
id integer optional
name string optional
filters object optional
archived boolean optional
end_date string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
parameters object optional
start_date string optional
updated_at string optional
description string optional
feature_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
feature_flag_key string optional
secondary_metrics object optional
application/x-www-form-urlencoded
schema PatchedExperiment
Property Type Required
id integer optional
name string optional
filters object optional
archived boolean optional
end_date string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
parameters object optional
start_date string optional
updated_at string optional
description string optional
feature_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
feature_flag_key string optional
secondary_metrics object optional

Responses

200 —
PATCH /api/projects/{project_id}/experiments/{id}

Explicitmembers 1 endpoints

PATCH /api/projects/{project_id}/explicit_members/{parent_membership__user__uuid}
operationId: Explicitmembers_updateParentMembershipUserUuid

Parameters

Name In Required Type Description
parent_membership__user__uuid path required string —
project_id path required string

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

Request Body

application/json
schema PatchedExplicitTeamMember
Property Type Required
id string optional
user object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
level integer optional
joined_at string optional
user_uuid string optional
updated_at string optional
parent_level integer optional
effective_level integer optional
parent_membership_id string optional
multipart/form-data
schema PatchedExplicitTeamMember
Property Type Required
id string optional
user object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
level integer optional
joined_at string optional
user_uuid string optional
updated_at string optional
parent_level integer optional
effective_level integer optional
parent_membership_id string optional
application/x-www-form-urlencoded
schema PatchedExplicitTeamMember
Property Type Required
id string optional
user object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
level integer optional
joined_at string optional
user_uuid string optional
updated_at string optional
parent_level integer optional
effective_level integer optional
parent_membership_id string optional

Responses

200 —
PATCH /api/projects/{project_id}/explicit_members/{parent_membership__user__uuid}

Featureflags 1 endpoints

PATCH /api/projects/{project_id}/feature_flags/{id}

Create, read, update and delete feature flags. See docs for more information on feature flags.

If you’re looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.

operationId: Featureflags_updateFeatureFlagById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this feature flag.
project_id path required string

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

Request Body

application/json
schema PatchedFeatureFlag
Property Type Required
id integer optional
key string optional
name string optional
tags array optional
active boolean optional
deleted boolean optional
filters object optional
surveys object optional
can_edit boolean optional
features object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
experiment_set array optional
is_simple_flag boolean optional
usage_dashboard integer optional
performed_rollback boolean optional
rollout_percentage integer optional
rollback_conditions object optional
analytics_dashboards array optional
has_enriched_analytics boolean optional
…1 more object optional
multipart/form-data
schema PatchedFeatureFlag
Property Type Required
id integer optional
key string optional
name string optional
tags array optional
active boolean optional
deleted boolean optional
filters object optional
surveys object optional
can_edit boolean optional
features object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
experiment_set array optional
is_simple_flag boolean optional
usage_dashboard integer optional
performed_rollback boolean optional
rollout_percentage integer optional
rollback_conditions object optional
analytics_dashboards array optional
has_enriched_analytics boolean optional
…1 more object optional
application/x-www-form-urlencoded
schema PatchedFeatureFlag
Property Type Required
id integer optional
key string optional
name string optional
tags array optional
active boolean optional
deleted boolean optional
filters object optional
surveys object optional
can_edit boolean optional
features object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
experiment_set array optional
is_simple_flag boolean optional
usage_dashboard integer optional
performed_rollback boolean optional
rollout_percentage integer optional
rollback_conditions object optional
analytics_dashboards array optional
has_enriched_analytics boolean optional
…1 more object optional

Responses

200 —
PATCH /api/projects/{project_id}/feature_flags/{id}

Groupstypes 1 endpoints

PATCH /api/projects/{project_id}/groups_types/update_metadata
operationId: Groupstypes_updateMetadataPatch

Parameters

Name In Required Type Description
project_id path required string

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

Request Body

application/json
schema PatchedGroupType
Property Type Required
group_type string optional
name_plural string optional
name_singular string optional
group_type_index integer optional
multipart/form-data
schema PatchedGroupType
Property Type Required
group_type string optional
name_plural string optional
name_singular string optional
group_type_index integer optional
application/x-www-form-urlencoded
schema PatchedGroupType
Property Type Required
group_type string optional
name_plural string optional
name_singular string optional
group_type_index integer optional

Responses

200 —
PATCH /api/projects/{project_id}/groups_types/update_metadata

Insights 1 endpoints

PATCH /api/projects/{project_id}/insights/{id}
operationId: Insights_updateInsightPath

Parameters

Name In Required Type Description
format query optional string —
id path required integer

A unique integer value identifying this insight.
project_id path required string

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

Request Body

application/json
schema PatchedInsight
Property Type Required
id integer optional
name string optional
tags array optional
order integer optional
query object optional
saved boolean optional
result string optional
deleted boolean optional
filters object optional
short_id string optional
timezone string optional
favorited boolean optional
is_cached string optional
is_sample boolean optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
dashboards array optional
updated_at string optional
description string optional
derived_name string optional
…7 more object optional

Responses

200 —
PATCH /api/projects/{project_id}/insights/{id}

Notebooks 1 endpoints

PATCH /api/projects/{project_id}/notebooks/{short_id}

The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.

operationId: Notebooks_updateNotebook

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
short_id path required string —

Request Body

application/json
schema PatchedNotebook
Property Type Required
id string optional
title string optional
content object optional
deleted boolean optional
version integer optional
short_id string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
text_content string optional
last_modified_at string optional
last_modified_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
multipart/form-data
schema PatchedNotebook
Property Type Required
id string optional
title string optional
content object optional
deleted boolean optional
version integer optional
short_id string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
text_content string optional
last_modified_at string optional
last_modified_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
application/x-www-form-urlencoded
schema PatchedNotebook
Property Type Required
id string optional
title string optional
content object optional
deleted boolean optional
version integer optional
short_id string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
text_content string optional
last_modified_at string optional
last_modified_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional

Responses

200 —
PATCH /api/projects/{project_id}/notebooks/{short_id}

Organizations 17 endpoints

PATCH /api/organizations/{id}
operationId: partial_update

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this organization.

Request Body

application/json
schema PatchedOrganization
Property Type Required
id string optional
name string optional
slug string optional
teams array optional
metadata string optional
created_at string optional
updated_at string optional
customer_id string optional
enforce_2fa boolean optional
member_count string optional
membership_level integer optional
available_features array optional
plugins_access_level integer optional
available_product_features array optional
is_member_join_email_enabled boolean optional
multipart/form-data
schema PatchedOrganization
Property Type Required
id string optional
name string optional
slug string optional
teams array optional
metadata string optional
created_at string optional
updated_at string optional
customer_id string optional
enforce_2fa boolean optional
member_count string optional
membership_level integer optional
available_features array optional
plugins_access_level integer optional
available_product_features array optional
is_member_join_email_enabled boolean optional
application/x-www-form-urlencoded
schema PatchedOrganization
Property Type Required
id string optional
name string optional
slug string optional
teams array optional
metadata string optional
created_at string optional
updated_at string optional
customer_id string optional
enforce_2fa boolean optional
member_count string optional
membership_level integer optional
available_features array optional
plugins_access_level integer optional
available_product_features array optional
is_member_join_email_enabled boolean optional

Responses

200 —
PATCH /api/organizations/{id}
PATCH /api/organizations/{organization_id}/batch_exports/{id}
operationId: Organizations_updateBatchExport

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Request Body

application/json
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
└ type string required
└ config object optional
hogql_query string optional
latest_runs array optional
└ id string required
└ cursor string optional
└ status string required
└ created_at string required
└ finished_at string optional
└ batch_export string required
└ latest_error string optional
└ last_updated_at string required
└ data_interval_end string required
└ records_completed integer optional
└ data_interval_start string required
└ records_total_count integer optional
last_paused_at string optional
last_updated_at string optional
multipart/form-data
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
└ type string required
└ config object optional
hogql_query string optional
latest_runs array optional
└ id string required
└ cursor string optional
└ status string required
└ created_at string required
└ finished_at string optional
└ batch_export string required
└ latest_error string optional
└ last_updated_at string required
└ data_interval_end string required
└ records_completed integer optional
└ data_interval_start string required
└ records_total_count integer optional
last_paused_at string optional
last_updated_at string optional
application/x-www-form-urlencoded
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
└ type string required
└ config object optional
hogql_query string optional
latest_runs array optional
└ id string required
└ cursor string optional
└ status string required
└ created_at string required
└ finished_at string optional
└ batch_export string required
└ latest_error string optional
└ last_updated_at string required
└ data_interval_end string required
└ records_completed integer optional
└ data_interval_start string required
└ records_total_count integer optional
last_paused_at string optional
last_updated_at string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/batch_exports/{id}
PATCH /api/organizations/{organization_id}/domains/{id}
operationId: Organizations_updateDomainById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this domain.
organization_id path required string —

Request Body

application/json
schema PatchedOrganizationDomain
Property Type Required
id string optional
domain string optional
has_saml boolean optional
is_verified boolean optional
verified_at string optional
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string optional
jit_provisioning_enabled boolean optional
multipart/form-data
schema PatchedOrganizationDomain
Property Type Required
id string optional
domain string optional
has_saml boolean optional
is_verified boolean optional
verified_at string optional
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string optional
jit_provisioning_enabled boolean optional
application/x-www-form-urlencoded
schema PatchedOrganizationDomain
Property Type Required
id string optional
domain string optional
has_saml boolean optional
is_verified boolean optional
verified_at string optional
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string optional
jit_provisioning_enabled boolean optional

Responses

200 —
PATCH /api/organizations/{organization_id}/domains/{id}
PATCH /api/organizations/{organization_id}/members/{user__uuid}
operationId: Organizations_updateMemberByUuid

Parameters

Name In Required Type Description
organization_id path required string —
user__uuid path required string —

Request Body

application/json
schema PatchedOrganizationMember
Property Type Required
id string optional
user object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
level integer optional
joined_at string optional
updated_at string optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
multipart/form-data
schema PatchedOrganizationMember
Property Type Required
id string optional
user object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
level integer optional
joined_at string optional
updated_at string optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
application/x-www-form-urlencoded
schema PatchedOrganizationMember
Property Type Required
id string optional
user object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
level integer optional
joined_at string optional
updated_at string optional
is_2fa_enabled boolean optional
has_social_auth boolean optional

Responses

200 —
PATCH /api/organizations/{organization_id}/members/{user__uuid}
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}
operationId: Organizations_updatePipelineDestination

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}/update_source
operationId: Organizations_updatePipelineDestinationSourcePartialUpdate

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}/update_source
PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
operationId: Organizations_updatePipelineFrontendAppsById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/update_source
operationId: Organizations_pipelineFrontendAppsUpdateSourcePatch

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/update_source
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}
operationId: Organizations_updatePipelineImportAppsConfigs

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}/update_source
operationId: Organizations_updatePipelineImportAppSource

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_import_apps/{id}/update_source
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}
operationId: Organizations_updatePipelineTransformationById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}/update_source
operationId: Organizations_updatePipelineTransformationSourcePartialUpdate

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_transformations/{id}/update_source
PATCH /api/organizations/{organization_id}/plugins/{id}
operationId: Organizations_updatePluginById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/plugins/{id}
PATCH /api/organizations/{organization_id}/plugins/{id}/update_source
operationId: Organizations_updatePluginSource

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/plugins/{id}/update_source
PATCH /api/organizations/{organization_id}/projects/{id}

Projects for the current organization.

operationId: Organizations_updateProject

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this team.
organization_id path required string —

Request Body

application/json
schema PatchedTeam
Property Type Required
id integer optional
name string optional
uuid string optional
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string optional
created_at string optional
updated_at string optional
organization string optional
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean optional
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean optional
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional
multipart/form-data
schema PatchedTeam
Property Type Required
id integer optional
name string optional
uuid string optional
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string optional
created_at string optional
updated_at string optional
organization string optional
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean optional
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean optional
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional
application/x-www-form-urlencoded
schema PatchedTeam
Property Type Required
id integer optional
name string optional
uuid string optional
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string optional
created_at string optional
updated_at string optional
organization string optional
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean optional
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean optional
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional

Responses

200 —
PATCH /api/organizations/{organization_id}/projects/{id}
PATCH /api/organizations/{organization_id}/projects/{id}/reset_token

Projects for the current organization.

operationId: Organizations_projectsResetTokenPartialUpdate

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this team.
organization_id path required string —

Request Body

application/json
schema PatchedTeam
Property Type Required
id integer optional
name string optional
uuid string optional
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string optional
created_at string optional
updated_at string optional
organization string optional
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean optional
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean optional
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional
multipart/form-data
schema PatchedTeam
Property Type Required
id integer optional
name string optional
uuid string optional
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string optional
created_at string optional
updated_at string optional
organization string optional
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean optional
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean optional
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional
application/x-www-form-urlencoded
schema PatchedTeam
Property Type Required
id integer optional
name string optional
uuid string optional
is_demo boolean optional
app_urls array optional
timezone string optional
api_token string optional
created_at string optional
updated_at string optional
organization string optional
anonymize_ips boolean optional
access_control boolean optional
extra_settings object optional
ingested_event boolean optional
surveys_opt_in boolean optional
week_start_day object optional
data_attributes object optional
has_group_types boolean optional
inject_web_apps boolean optional
primary_dashboard integer optional
…24 more object optional

Responses

200 —
PATCH /api/organizations/{organization_id}/projects/{id}/reset_token
PATCH /api/organizations/{organization_id}/roles/{id}
operationId: Organizations_updateRoleById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this role.
organization_id path required string —

Request Body

application/json
schema PatchedRole
Property Type Required
id string optional
name string optional
members string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
associated_flags string optional
feature_flags_access_level integer optional
multipart/form-data
schema PatchedRole
Property Type Required
id string optional
name string optional
members string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
associated_flags string optional
feature_flags_access_level integer optional
application/x-www-form-urlencoded
schema PatchedRole
Property Type Required
id string optional
name string optional
members string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
associated_flags string optional
feature_flags_access_level integer optional

Responses

200 —
PATCH /api/organizations/{organization_id}/roles/{id}

Persons 1 endpoints

PATCH /api/projects/{project_id}/persons/{id}

To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.

operationId: Persons_updatePersonById

Parameters

Name In Required Type Description
format query optional string —
id path required integer

A unique integer value identifying this person.
project_id path required string

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

Request Body

application/json
schema PatchedPerson
Property Type Required
id integer optional
name string optional
uuid string optional
created_at string optional
properties object optional
distinct_ids array optional
multipart/form-data
schema PatchedPerson
Property Type Required
id integer optional
name string optional
uuid string optional
created_at string optional
properties object optional
distinct_ids array optional
application/x-www-form-urlencoded
schema PatchedPerson
Property Type Required
id integer optional
name string optional
uuid string optional
created_at string optional
properties object optional
distinct_ids array optional

Responses

200 —
PATCH /api/projects/{project_id}/persons/{id}

Pipelinedestinationconfigs 2 endpoints

PATCH /api/projects/{project_id}/pipeline_destination_configs/rearrange
operationId: Pipelinedestinationconfigs_rearrangePartialUpdate

Parameters

Name In Required Type Description
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_destination_configs/rearrange
PATCH /api/projects/{project_id}/pipeline_destination_configs/{id}
operationId: Pipelinedestinationconfigs_patchById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin config.
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_destination_configs/{id}

Pipelinefrontendappsconfigs 2 endpoints

PATCH /api/projects/{project_id}/pipeline_frontend_apps_configs/rearrange
operationId: Pipelinefrontendappsconfigs_rearrangePartialUpdate

Parameters

Name In Required Type Description
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_frontend_apps_configs/rearrange
PATCH /api/projects/{project_id}/pipeline_frontend_apps_configs/{id}
operationId: Pipelinefrontendappsconfigs_updateByIdPatch

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin config.
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_frontend_apps_configs/{id}

Pipelineimportappsconfigs 2 endpoints

PATCH /api/projects/{project_id}/pipeline_import_apps_configs/rearrange
operationId: Pipelineimportappsconfigs_rearrangePartialUpdate

Parameters

Name In Required Type Description
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_import_apps_configs/rearrange
PATCH /api/projects/{project_id}/pipeline_import_apps_configs/{id}
operationId: Pipelineimportappsconfigs_patchById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin config.
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_import_apps_configs/{id}

Pipelinetransformationconfigs 2 endpoints

PATCH /api/projects/{project_id}/pipeline_transformation_configs/rearrange
operationId: Pipelinetransformationconfigs_rearrangePartialUpdate

Parameters

Name In Required Type Description
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_transformation_configs/rearrange
PATCH /api/projects/{project_id}/pipeline_transformation_configs/{id}
operationId: Pipelinetransformationconfigs_patchById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin config.
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/pipeline_transformation_configs/{id}

Pluginconfigs 2 endpoints

PATCH /api/projects/{project_id}/plugin_configs/rearrange
operationId: Pluginconfigs_rearrangePatch

Parameters

Name In Required Type Description
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/plugin_configs/rearrange
PATCH /api/projects/{project_id}/plugin_configs/{id}
operationId: Pluginconfigs_updateByIdPatch

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin config.
project_id path required string

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

Request Body

application/json
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
multipart/form-data
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional
application/x-www-form-urlencoded
schema PatchedPluginConfig
Property Type Required
id integer optional
name string optional
error string optional
order integer optional
config string optional
plugin integer optional
deleted boolean optional
enabled boolean optional
team_id integer optional
created_at string optional
updated_at string optional
description string optional
plugin_info string optional
delivery_rate_24h string optional

Responses

200 —
PATCH /api/projects/{project_id}/plugin_configs/{id}

Propertydefinitions 1 endpoints

PATCH /api/projects/{project_id}/property_definitions/{id}
operationId: Propertydefinitions_patchByIdProperty

Parameters

Name In Required Type Description
id path required string —
project_id path required string

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

Responses

200

No response body
PATCH /api/projects/{project_id}/property_definitions/{id}

Sessionrecordingplaylists 1 endpoints

PATCH /api/projects/{project_id}/session_recording_playlists/{short_id}
operationId: Sessionrecordingplaylists_updateShortId

Parameters

Name In Required Type Description
project_id path required string

Project ID of the project you’re trying to access. To find the ID of the project, make a call to /api/projects/.
short_id path required string —

Request Body

application/json
schema PatchedSessionRecordingPlaylist
Property Type Required
id integer optional
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string optional
last_modified_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
multipart/form-data
schema PatchedSessionRecordingPlaylist
Property Type Required
id integer optional
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string optional
last_modified_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
application/x-www-form-urlencoded
schema PatchedSessionRecordingPlaylist
Property Type Required
id integer optional
name string optional
pinned boolean optional
deleted boolean optional
filters object optional
short_id string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
description string optional
derived_name string optional
last_modified_at string optional
last_modified_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional

Responses

200 —
PATCH /api/projects/{project_id}/session_recording_playlists/{short_id}

Subscriptions 1 endpoints

PATCH /api/projects/{project_id}/subscriptions/{id}
operationId: Subscriptions_updateById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this subscription.
project_id path required string

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

Request Body

application/json
schema PatchedSubscription
Property Type Required
id integer optional
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string optional
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
until_date string optional
target_type string optional
target_value string optional
invite_message string optional
next_delivery_date string optional
multipart/form-data
schema PatchedSubscription
Property Type Required
id integer optional
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string optional
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
until_date string optional
target_type string optional
target_value string optional
invite_message string optional
next_delivery_date string optional
application/x-www-form-urlencoded
schema PatchedSubscription
Property Type Required
id integer optional
count integer optional
title string optional
deleted boolean optional
insight integer optional
summary string optional
bysetpos integer optional
interval integer optional
byweekday array optional
dashboard integer optional
frequency string optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
until_date string optional
target_type string optional
target_value string optional
invite_message string optional
next_delivery_date string optional

Responses

200 —
PATCH /api/projects/{project_id}/subscriptions/{id}

Surveys 1 endpoints

PATCH /api/projects/{project_id}/surveys/{id}
operationId: Surveys_updateSurveyById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this survey.
project_id path required string

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

Request Body

application/json
schema PatchedSurveySerializerCreateUpdateOnly
Property Type Required
id string optional
name string optional
type string optional
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional
multipart/form-data
schema PatchedSurveySerializerCreateUpdateOnly
Property Type Required
id string optional
name string optional
type string optional
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional
application/x-www-form-urlencoded
schema PatchedSurveySerializerCreateUpdateOnly
Property Type Required
id string optional
name string optional
type string optional
archived boolean optional
end_date string optional
questions object optional
appearance object optional
conditions object optional
created_at string optional
created_by object optional
└ id integer required
└ uuid string required
└ email string required
└ last_name string optional
└ first_name string optional
└ distinct_id string optional
└ is_email_verified boolean optional
start_date string optional
description string optional
linked_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
linked_flag_id integer optional
targeting_flag object optional
└ id integer required
└ key string required
└ name string optional
└ active boolean optional
└ deleted boolean optional
└ filters object optional
└ team_id integer required
└ ensure_experience_continuity boolean optional
targeting_flag_id integer optional
remove_targeting_flag boolean optional
targeting_flag_filters object optional

Responses

200 —
PATCH /api/projects/{project_id}/surveys/{id}

Users 1 endpoints

PATCH /api/users/{uuid}
operationId: Users_patchUuid

Parameters

Name In Required Type Description
uuid path required string —

Request Body

application/json
schema PatchedUser
Property Type Required
team object optional
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string optional
email string optional
is_staff boolean optional
password string optional
last_name string optional
first_name string optional
theme_mode object optional
date_joined string optional
distinct_id string optional
email_opt_in boolean optional
has_password boolean optional
organization object optional
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array optional
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
is_impersonated boolean optional
…8 more object optional
multipart/form-data
schema PatchedUser
Property Type Required
team object optional
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string optional
email string optional
is_staff boolean optional
password string optional
last_name string optional
first_name string optional
theme_mode object optional
date_joined string optional
distinct_id string optional
email_opt_in boolean optional
has_password boolean optional
organization object optional
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array optional
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
is_impersonated boolean optional
…8 more object optional
application/x-www-form-urlencoded
schema PatchedUser
Property Type Required
team object optional
└ id integer required
└ name string required
└ uuid string required
└ is_demo boolean required
└ timezone string required
└ api_token string required
└ organization string required
└ access_control boolean required
└ ingested_event boolean required
└ completed_snippet_onboarding boolean required
└ has_completed_onboarding_for object required
uuid string optional
email string optional
is_staff boolean optional
password string optional
last_name string optional
first_name string optional
theme_mode object optional
date_joined string optional
distinct_id string optional
email_opt_in boolean optional
has_password boolean optional
organization object optional
└ id string required
└ name string required
└ slug string required
└ teams array required
└ metadata string required
└ created_at string required
└ updated_at string required
└ customer_id string required
└ enforce_2fa boolean optional
└ member_count string required
└ membership_level integer required
└ available_features array required
└ plugins_access_level integer required
└ available_product_features array required
└ is_member_join_email_enabled boolean optional
toolbar_mode object optional
organizations array optional
└ id string required
└ name string required
└ slug string required
└ membership_level integer required
pending_email string optional
anonymize_data boolean optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
is_impersonated boolean optional
…8 more object optional

Responses

200 —
PATCH /api/users/{uuid}
Load more endpoints

Schemas

object Action 
{
  "type": "object",
  "required": [
    "bytecode_error",
    "created_at",
    "created_by",
    "id",
    "is_action",
    "is_calculating",
    "team_id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "tags": {
      "type": "array",
      "items": {}
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActionStep"
      }
    },
    "deleted": {
      "type": "boolean"
    },
    "team_id": {
      "type": "integer",
      "readOnly": true
    },
    "is_action": {
      "type": "boolean",
      "default": true,
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "$ref": "#/components/schemas/UserBasic"
    },
    "description": {
      "type": "string"
    },
    "post_to_slack": {
      "type": "boolean"
    },
    "bytecode_error": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "is_calculating": {
      "type": "boolean",
      "readOnly": true
    },
    "last_calculated_at": {
      "type": "string",
      "format": "date-time"
    },
    "slack_message_format": {
      "type": "string",
      "maxLength": 600
    }
  },
  "description": "Serializer mixin that resolves appropriate response for tags depending on license.",
  "x-konfig-properties": {
    "created_by": {
      "readOnly": true
    }
  }
}
object ActionStep 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 65535
    },
    "href": {
      "type": "string",
      "nullable": true,
      "maxLength": 65535
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "text": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "event": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "selector": {
      "type": "string",
      "nullable": true,
      "maxLength": 65535
    },
    "tag_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "properties": {
      "nullable": true
    },
    "url_matching": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/UrlMatchingEnum"
        },
        {
          "$ref": "#/components/schemas/BlankEnum"
        },
        {
          "$ref": "#/components/schemas/NullEnum"
        }
      ],
      "nullable": true
    },
    "href_matching": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/UrlMatchingEnum"
        },
        {
          "$ref": "#/components/schemas/BlankEnum"
        },
        {
          "$ref": "#/components/schemas/NullEnum"
        }
      ],
      "nullable": true
    },
    "text_matching": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/UrlMatchingEnum"
        },
        {
          "$ref": "#/components/schemas/BlankEnum"
        },
        {
          "$ref": "#/components/schemas/NullEnum"
        }
      ],
      "nullable": true
    }
  }
}
object ActionsNode 
{
  "type": "object",
  "title": "ActionsNode",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "title": "Id"
    },
    "kind": {
      "const": "ActionsNode",
      "title": "Kind",
      "default": "ActionsNode"
    },
    "math": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/BaseMathType"
        },
        {
          "$ref": "#/components/schemas/PropertyMathType"
        },
        {
          "$ref": "#/components/schemas/CountPerActorMathType"
        },
        {
          "const": "unique_group"
        },
        {
          "const": "hogql"
        }
      ],
      "title": "Math",
      "default": null,
      "nullable": true
    },
    "name": {
      "type": "string",
      "title": "Name",
      "default": null,
      "nullable": true
    },
    "response": {
      "type": "object",
      "title": "Response",
      "default": null,
      "nullable": true,
      "description": "Cached query response"
    },
    "math_hogql": {
      "type": "string",
      "title": "Math Hogql",
      "default": null,
      "nullable": true
    },
    "properties": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/EventPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/PersonPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/ElementPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/SessionPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/CohortPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/RecordingDurationFilter"
          },
          {
            "$ref": "#/components/schemas/GroupPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/FeaturePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/HogQLPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/EmptyPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
          }
        ]
      },
      "title": "Properties",
      "default": null,
      "nullable": true,
      "description": "Properties configurable in the interface"
    },
    "custom_name": {
      "type": "string",
      "title": "Custom Name",
      "default": null,
      "nullable": true
    },
    "math_property": {
      "type": "string",
      "title": "Math Property",
      "default": null,
      "nullable": true
    },
    "fixedProperties": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/EventPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/PersonPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/ElementPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/SessionPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/CohortPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/RecordingDurationFilter"
          },
          {
            "$ref": "#/components/schemas/GroupPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/FeaturePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/HogQLPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/EmptyPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
          }
        ]
      },
      "title": "Fixedproperties",
      "default": null,
      "nullable": true,
      "description": "Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person)"
    },
    "math_group_type_index": {
      "$ref": "#/components/schemas/MathGroupTypeIndexNullable"
    }
  }
}
object ActivityLog 
{
  "type": "object",
  "required": [
    "activity",
    "id",
    "scope",
    "unread",
    "user"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "user": {
      "$ref": "#/components/schemas/UserBasic"
    },
    "scope": {
      "type": "string",
      "maxLength": 79
    },
    "detail": {
      "nullable": true
    },
    "unread": {
      "type": "boolean",
      "readOnly": true,
      "description": "is the date of this log item newer than the user's bookmark"
    },
    "item_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 72
    },
    "activity": {
      "type": "string",
      "maxLength": 79
    },
    "is_system": {
      "type": "boolean",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "organization_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "was_impersonated": {
      "type": "boolean",
      "nullable": true
    }
  }
}
object ActorsQuery 
{
  "type": "object",
  "title": "ActorsQuery",
  "properties": {
    "kind": {
      "const": "ActorsQuery",
      "title": "Kind",
      "default": "ActorsQuery"
    },
    "limit": {
      "type": "integer",
      "title": "Limit",
      "default": null,
      "nullable": true
    },
    "offset": {
      "type": "integer",
      "title": "Offset",
      "default": null,
      "nullable": true
    },
    "search": {
      "type": "string",
      "title": "Search",
      "default": null,
      "nullable": true
    },
    "select": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Select",
      "default": null,
      "nullable": true
    },
    "source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/InsightActorsQuery"
        },
        {
          "$ref": "#/components/schemas/FunnelsActorsQuery"
        },
        {
          "$ref": "#/components/schemas/FunnelCorrelationActorsQuery"
        },
        {
          "$ref": "#/components/schemas/HogQLQuery"
        }
      ],
      "title": "Source",
      "default": null,
      "nullable": true
    },
    "orderBy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Orderby",
      "default": null,
      "nullable": true
    },
    "response": {
      "$ref": "#/components/schemas/ActorsQueryResponseNullable"
    },
    "properties": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/EventPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/PersonPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/ElementPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/SessionPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/CohortPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/RecordingDurationFilter"
          },
          {
            "$ref": "#/components/schemas/GroupPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/FeaturePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/HogQLPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/EmptyPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
          }
        ]
      },
      "title": "Properties",
      "default": null,
      "nullable": true
    },
    "fixedProperties": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/EventPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/PersonPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/ElementPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/SessionPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/CohortPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/RecordingDurationFilter"
          },
          {
            "$ref": "#/components/schemas/GroupPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/FeaturePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/HogQLPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/EmptyPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
          }
        ]
      },
      "title": "Fixedproperties",
      "default": null,
      "nullable": true
    }
  }
}
object ActorsQueryResponse 
{
  "type": "object",
  "title": "ActorsQueryResponse",
  "required": [
    "columns",
    "hogql",
    "limit",
    "offset",
    "results",
    "types"
  ],
  "properties": {
    "hogql": {
      "type": "string",
      "title": "Hogql"
    },
    "limit": {
      "type": "integer",
      "title": "Limit"
    },
    "types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Types"
    },
    "offset": {
      "type": "integer",
      "title": "Offset"
    },
    "columns": {
      "type": "array",
      "items": {},
      "title": "Columns"
    },
    "hasMore": {
      "type": "boolean",
      "title": "Hasmore",
      "default": null,
      "nullable": true
    },
    "results": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {}
      },
      "title": "Results"
    },
    "timings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/QueryTiming"
      },
      "title": "Timings",
      "default": null,
      "nullable": true
    },
    "missing_actors_count": {
      "type": "integer",
      "title": "Missing Actors Count",
      "default": null,
      "nullable": true
    }
  }
}
object ActorsQueryResponseNullable 
{
  "type": "object",
  "title": "ActorsQueryResponse",
  "default": null,
  "nullable": true,
  "required": [
    "columns",
    "hogql",
    "limit",
    "offset",
    "results",
    "types"
  ],
  "properties": {
    "hogql": {
      "type": "string",
      "title": "Hogql"
    },
    "limit": {
      "type": "integer",
      "title": "Limit"
    },
    "types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Types"
    },
    "offset": {
      "type": "integer",
      "title": "Offset"
    },
    "columns": {
      "type": "array",
      "items": {},
      "title": "Columns"
    },
    "hasMore": {
      "type": "boolean",
      "title": "Hasmore",
      "default": null,
      "nullable": true
    },
    "results": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {}
      },
      "title": "Results"
    },
    "timings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/QueryTiming"
      },
      "title": "Timings",
      "default": null,
      "nullable": true
    },
    "missing_actors_count": {
      "type": "integer",
      "title": "Missing Actors Count",
      "default": null,
      "nullable": true
    }
  }
}
string AggregationAxisFormat 
{
  "enum": [
    "numeric",
    "duration",
    "duration_ms",
    "percentage",
    "percentage_scaled"
  ],
  "type": "string",
  "title": "AggregationAxisFormat"
}
string AggregationAxisFormatNullable 
{
  "enum": [
    "numeric",
    "duration",
    "duration_ms",
    "percentage",
    "percentage_scaled"
  ],
  "type": "string",
  "title": "AggregationAxisFormat",
  "default": null,
  "nullable": true
}
object Annotation 
{
  "type": "object",
  "required": [
    "created_at",
    "created_by",
    "id",
    "insight_name",
    "insight_short_id",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "scope": {
      "$ref": "#/components/schemas/AnnotationScopeEnum"
    },
    "content": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "deleted": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "readOnly": true
    },
    "created_by": {
      "$ref": "#/components/schemas/UserBasic"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "date_marker": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "insight_name": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "creation_type": {
      "$ref": "#/components/schemas/CreationTypeEnum"
    },
    "dashboard_item": {
      "type": "integer",
      "nullable": true
    },
    "insight_short_id": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "x-konfig-properties": {
    "created_by": {
      "readOnly": true
    }
  }
}
string AnnotationScopeEnum 
{
  "enum": [
    "dashboard_item",
    "project",
    "organization"
  ],
  "type": "string",
  "description": "* `dashboard_item` - insight\n* `project` - project\n* `organization` - organization"
}
object AutocompleteCompletionItem 
{
  "type": "object",
  "title": "AutocompleteCompletionItem",
  "required": [
    "insertText",
    "kind",
    "label"
  ],
  "properties": {
    "kind": {
      "$ref": "#/components/schemas/Kind"
    },
    "label": {
      "type": "string",
      "title": "Label",
      "description": "The label of this completion item. By default this is also the text that is inserted when selecting this completion."
    },
    "detail": {
      "type": "string",
      "title": "Detail",
      "default": null,
      "nullable": true,
      "description": "A human-readable string with additional information about this item, like type or symbol information."
    },
    "insertText": {
      "type": "string",
      "title": "Inserttext",
      "description": "A string or snippet that should be inserted in a document when selecting this completion."
    },
    "documentation": {
      "type": "string",
      "title": "Documentation",
      "default": null,
      "nullable": true,
      "description": "A human-readable string that represents a doc-comment."
    }
  },
  "x-konfig-properties": {
    "kind": {
      "description": "The kind of this completion item. Based on the kind an icon is chosen by the editor."
    }
  }
}
string BaseMathType 
{
  "enum": [
    "total",
    "dau",
    "weekly_active",
    "monthly_active",
    "unique_session"
  ],
  "type": "string",
  "title": "BaseMathType"
}
object BatchExport 
{
  "type": "object",
  "required": [
    "created_at",
    "destination",
    "id",
    "interval",
    "last_updated_at",
    "latest_runs",
    "name",
    "schema",
    "team_id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "A human-readable name for this BatchExport."
    },
    "end_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Time after which any Batch Export runs won't be triggered."
    },
    "paused": {
      "type": "boolean",
      "description": "Whether this BatchExport is paused or not."
    },
    "schema": {
      "nullable": true,
      "readOnly": true,
      "description": "A schema of custom fields to select when exporting data."
    },
    "team_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The team this belongs to."
    },
    "interval": {
      "$ref": "#/components/schemas/IntervalEnum"
    },
    "start_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Time before which any Batch Export runs won't be triggered."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The timestamp at which this BatchExport was created."
    },
    "destination": {
      "$ref": "#/components/schemas/BatchExportDestination"
    },
    "hogql_query": {
      "type": "string"
    },
    "latest_runs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BatchExportRun"
      },
      "readOnly": true
    },
    "last_paused_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The timestamp at which this BatchExport was last paused."
    },
    "last_updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The timestamp at which this BatchExport was last updated."
    }
  },
  "description": "Serializer for a BatchExport model."
}
object BatchExportDestination 
{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/BatchExportDestinationTypeEnum"
    },
    "config": {
      "description": "A JSON field to store all configuration parameters required to access a BatchExportDestination."
    }
  },
  "description": "Serializer for an BatchExportDestination model.",
  "x-konfig-properties": {
    "type": {
      "description": "A choice of supported BatchExportDestination types.\n\n* `S3` - S3\n* `Snowflake` - Snowflake\n* `Postgres` - Postgres\n* `Redshift` - Redshift\n* `BigQuery` - Bigquery\n* `HTTP` - Http\n* `NoOp` - Noop"
    }
  }
}
string BatchExportDestinationTypeEnum 
{
  "enum": [
    "S3",
    "Snowflake",
    "Postgres",
    "Redshift",
    "BigQuery",
    "HTTP",
    "NoOp"
  ],
  "type": "string",
  "description": "* `S3` - S3\n* `Snowflake` - Snowflake\n* `Postgres` - Postgres\n* `Redshift` - Redshift\n* `BigQuery` - Bigquery\n* `HTTP` - Http\n* `NoOp` - Noop"
}
object BatchExportLogEntry 
{
  "type": "object",
  "required": [
    "batch_export_id",
    "level",
    "message",
    "run_id",
    "team_id",
    "timestamp"
  ],
  "properties": {
    "level": {
      "$ref": "#/components/schemas/BatchExportLogEntryLevelEnum"
    },
    "run_id": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "team_id": {
      "type": "integer"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "batch_export_id": {
      "type": "string"
    }
  }
}
string BatchExportLogEntryLevelEnum 
{
  "enum": [
    "DEBUG",
    "LOG",
    "INFO",
    "WARNING",
    "ERROR"
  ],
  "type": "string",
  "description": "* `DEBUG` - DEBUG\n* `LOG` - LOG\n* `INFO` - INFO\n* `WARNING` - WARNING\n* `ERROR` - ERROR"
}
object BatchExportRun 
{
  "type": "object",
  "required": [
    "batch_export",
    "created_at",
    "data_interval_end",
    "data_interval_start",
    "id",
    "last_updated_at",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "cursor": {
      "type": "string",
      "nullable": true,
      "description": "An opaque cursor that may be used to resume."
    },
    "status": {
      "$ref": "#/components/schemas/StatusEnum"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The timestamp at which this BatchExportRun was created."
    },
    "finished_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The timestamp at which this BatchExportRun finished, successfully or not."
    },
    "batch_export": {
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "description": "The BatchExport this run belongs to."
    },
    "latest_error": {
      "type": "string",
      "nullable": true,
      "description": "The latest error that occurred during this run."
    },
    "last_updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The timestamp at which this BatchExportRun was last updated."
    },
    "data_interval_end": {
      "type": "string",
      "format": "date-time",
      "description": "The end of the data interval."
    },
    "records_completed": {
      "type": "integer",
      "maximum": 2147483647,
      "minimum": -2147483648,
      "nullable": true,
      "description": "The number of records that have been exported."
    },
    "data_interval_start": {
      "type": "string",
      "format": "date-time",
      "description": "The start of the data interval."
    },
    "records_total_count": {
      "type": "integer",
      "maximum": 2147483647,
      "minimum": -2147483648,
      "nullable": true,
      "description": "The total count of records that should be exported in this BatchExportRun."
    }
  },
  "description": "Serializer for a BatchExportRun model.",
  "x-konfig-properties": {
    "status": {
      "description": "The status of this run.\n\n* `Cancelled` - Cancelled\n* `Completed` - Completed\n* `ContinuedAsNew` - Continued As New\n* `Failed` - Failed\n* `FailedRetryable` - Failed Retryable\n* `Terminated` - Terminated\n* `TimedOut` - Timedout\n* `Running` - Running\n* `Starting` - Starting"
    }
  }
}
string BlankEnum 
{
  "enum": [
    ""
  ],
  "type": "string"
}
object Breakdown 
{
  "type": "object",
  "title": "Breakdown",
  "required": [
    "property",
    "type"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/BreakdownType"
    },
    "property": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ],
      "title": "Property"
    },
    "normalize_url": {
      "type": "boolean",
      "title": "Normalize Url",
      "default": null,
      "nullable": true
    }
  }
}
string BreakdownAttributionType 
{
  "enum": [
    "first_touch",
    "last_touch",
    "all_events",
    "step"
  ],
  "type": "string",
  "title": "BreakdownAttributionType"
}
string BreakdownAttributionTypeNullable 
{
  "enum": [
    "first_touch",
    "last_touch",
    "all_events",
    "step"
  ],
  "type": "string",
  "title": "BreakdownAttributionType",
  "default": null,
  "nullable": true
}
object BreakdownFilter 
{
  "type": "object",
  "title": "BreakdownFilter",
  "properties": {
    "breakdown": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ]
          }
        }
      ],
      "title": "Breakdown",
      "default": null,
      "nullable": true
    },
    "breakdowns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Breakdown"
      },
      "title": "Breakdowns",
      "default": null,
      "nullable": true
    },
    "breakdown_type": {
      "$ref": "#/components/schemas/BreakdownTypeNullable"
    },
    "breakdown_limit": {
      "type": "integer",
      "title": "Breakdown Limit",
      "default": null,
      "nullable": true
    },
    "breakdown_normalize_url": {
      "type": "boolean",
      "title": "Breakdown Normalize Url",
      "default": null,
      "nullable": true
    },
    "breakdown_group_type_index": {
      "type": "integer",
      "title": "Breakdown Group Type Index",
      "default": null,
      "nullable": true
    },
    "breakdown_histogram_bin_count": {
      "type": "integer",
      "title": "Breakdown Histogram Bin Count",
      "default": null,
      "nullable": true
    },
    "breakdown_hide_other_aggregation": {
      "type": "boolean",
      "title": "Breakdown Hide Other Aggregation",
      "default": null,
      "nullable": true
    }
  }
}
object BreakdownFilterNullable 
{
  "type": "object",
  "title": "BreakdownFilter",
  "default": null,
  "nullable": true,
  "properties": {
    "breakdown": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ]
          }
        }
      ],
      "title": "Breakdown",
      "default": null,
      "nullable": true
    },
    "breakdowns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Breakdown"
      },
      "title": "Breakdowns",
      "default": null,
      "nullable": true
    },
    "breakdown_type": {
      "$ref": "#/components/schemas/BreakdownTypeNullable"
    },
    "breakdown_limit": {
      "type": "integer",
      "title": "Breakdown Limit",
      "default": null,
      "nullable": true
    },
    "breakdown_normalize_url": {
      "type": "boolean",
      "title": "Breakdown Normalize Url",
      "default": null,
      "nullable": true
    },
    "breakdown_group_type_index": {
      "type": "integer",
      "title": "Breakdown Group Type Index",
      "default": null,
      "nullable": true
    },
    "breakdown_histogram_bin_count": {
      "type": "integer",
      "title": "Breakdown Histogram Bin Count",
      "default": null,
      "nullable": true
    },
    "breakdown_hide_other_aggregation": {
      "type": "boolean",
      "title": "Breakdown Hide Other Aggregation",
      "default": null,
      "nullable": true
    }
  },
  "description": "Breakdown of the events and actions"
}
object BreakdownItem 
{
  "type": "object",
  "title": "BreakdownItem",
  "required": [
    "label",
    "value"
  ],
  "properties": {
    "label": {
      "type": "string",
      "title": "Label"
    },
    "value": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        }
      ],
      "title": "Value"
    }
  }
}
string BreakdownType 
{
  "enum": [
    "cohort",
    "person",
    "event",
    "group",
    "session",
    "hogql",
    "data_warehouse"
  ],
  "type": "string",
  "title": "BreakdownType"
}
string BreakdownTypeEnum 
{
  "enum": [
    "event",
    "person",
    "cohort",
    "group",
    "session",
    "hogql"
  ],
  "type": "string",
  "description": "* `event` - event\n* `person` - person\n* `cohort` - cohort\n* `group` - group\n* `session` - session\n* `hogql` - hogql"
}
string BreakdownTypeNullable 
{
  "enum": [
    "cohort",
    "person",
    "event",
    "group",
    "session",
    "hogql",
    "data_warehouse"
  ],
  "type": "string",
  "title": "BreakdownType",
  "default": null,
  "nullable": true
}
string ByweekdayEnum 
{
  "enum": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday",
    "saturday",
    "sunday"
  ],
  "type": "string",
  "description": "* `monday` - Monday\n* `tuesday` - Tuesday\n* `wednesday` - Wednesday\n* `thursday` - Thursday\n* `friday` - Friday\n* `saturday` - Saturday\n* `sunday` - Sunday"
}
object ChartAxis 
{
  "type": "object",
  "title": "ChartAxis",
  "required": [
    "column"
  ],
  "properties": {
    "column": {
      "type": "string",
      "title": "Column"
    }
  }
}
object ChartAxisNullable 
{
  "type": "object",
  "title": "ChartAxis",
  "default": null,
  "nullable": true,
  "required": [
    "column"
  ],
  "properties": {
    "column": {
      "type": "string",
      "title": "Column"
    }
  }
}
string ChartDisplayType 
{
  "enum": [
    "ActionsLineGraph",
    "ActionsBar",
    "ActionsAreaGraph",
    "ActionsLineGraphCumulative",
    "BoldNumber",
    "ActionsPie",
    "ActionsBarValue",
    "ActionsTable",
    "WorldMap"
  ],
  "type": "string",
  "title": "ChartDisplayType"
}
string ChartDisplayTypeNullable 
{
  "enum": [
    "ActionsLineGraph",
    "ActionsBar",
    "ActionsAreaGraph",
    "ActionsLineGraphCumulative",
    "BoldNumber",
    "ActionsPie",
    "ActionsBarValue",
    "ActionsTable",
    "WorldMap"
  ],
  "type": "string",
  "title": "ChartDisplayType",
  "default": null,
  "nullable": true
}
object ChartSettings 
{
  "type": "object",
  "title": "ChartSettings",
  "properties": {
    "xAxis": {
      "$ref": "#/components/schemas/ChartAxisNullable"
    },
    "yAxis": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ChartAxis"
      },
      "title": "Yaxis",
      "default": null,
      "nullable": true
    },
    "goalLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GoalLine"
      },
      "title": "Goallines",
      "default": null,
      "nullable": true
    }
  }
}
object ChartSettingsNullable 
{
  "type": "object",
  "title": "ChartSettings",
  "default": null,
  "nullable": true,
  "properties": {
    "xAxis": {
      "$ref": "#/components/schemas/ChartAxisNullable"
    },
    "yAxis": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ChartAxis"
      },
      "title": "Yaxis",
      "default": null,
      "nullable": true
    },
    "goalLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GoalLine"
      },
      "title": "Goallines",
      "default": null,
      "nullable": true
    }
  }
}
object ClickhouseEvent 
{
  "type": "object",
  "required": [
    "distinct_id",
    "elements",
    "elements_chain",
    "event",
    "id",
    "person",
    "properties",
    "timestamp"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "event": {
      "type": "string",
      "readOnly": true
    },
    "person": {
      "type": "string",
      "readOnly": true
    },
    "elements": {
      "type": "string",
      "readOnly": true
    },
    "timestamp": {
      "type": "string",
      "readOnly": true
    },
    "properties": {
      "type": "string",
      "readOnly": true
    },
    "distinct_id": {
      "type": "string",
      "readOnly": true
    },
    "elements_chain": {
      "type": "string",
      "readOnly": true
    }
  }
}
object Cohort 
{
  "type": "object",
  "required": [
    "count",
    "created_at",
    "created_by",
    "errors_calculating",
    "id",
    "is_calculating",
    "last_calculation"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "count": {
      "type": "integer",
      "nullable": true,
      "readOnly": true
    },
    "query": {
      "nullable": true
    },
    "groups": {},
    "deleted": {
      "type": "boolean"
    },
    "filters": {
      "nullable": true
    },
    "is_static": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "readOnly": true
    },
    "created_by": {
      "$ref": "#/components/schemas/UserBasic"
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    },
    "is_calculating": {
      "type": "boolean",
      "readOnly": true
    },
    "last_calculation": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "readOnly": true
    },
    "errors_calculating": {
      "type": "integer",
      "readOnly": true
    }
  },
  "x-konfig-properties": {
    "created_by": {
      "readOnly": true
    }
  }
}
object CohortPropertyFilter 
{
  "type": "object",
  "title": "CohortPropertyFilter",
  "required": [
    "value"
  ],
  "properties": {
    "key": {
      "const": "id",
      "title": "Key",
      "default": "id"
    },
    "type": {
      "const": "cohort",
      "title": "Type",
      "default": "cohort"
    },
    "label": {
      "type": "string",
      "title": "Label",
      "default": null,
      "nullable": true
    },
    "value": {
      "type": "integer",
      "title": "Value"
    }
  }
}
string Compare 
{
  "enum": [
    "current",
    "previous"
  ],
  "type": "string",
  "title": "Compare"
}
object CompareItem 
{
  "type": "object",
  "title": "CompareItem",
  "required": [
    "label",
    "value"
  ],
  "properties": {
    "label": {
      "type": "string",
      "title": "Label"
    },
    "value": {
      "type": "string",
      "title": "Value"
    }
  }
}
string CompareNullable 
{
  "enum": [
    "current",
    "previous"
  ],
  "type": "string",
  "title": "Compare",
  "default": null,
  "nullable": true
}
string CorrelationType 
{
  "enum": [
    "success",
    "failure"
  ],
  "type": "string",
  "title": "CorrelationType"
}
string CountPerActorMathType 
{
  "enum": [
    "avg_count_per_actor",
    "min_count_per_actor",
    "max_count_per_actor",
    "median_count_per_actor",
    "p90_count_per_actor",
    "p95_count_per_actor",
    "p99_count_per_actor"
  ],
  "type": "string",
  "title": "CountPerActorMathType"
}
string CreationModeEnum 
{
  "enum": [
    "default",
    "template",
    "duplicate"
  ],
  "type": "string",
  "description": "* `default` - Default\n* `template` - Template\n* `duplicate` - Duplicate"
}
string CreationTypeEnum 
{
  "enum": [
    "USR",
    "GIT"
  ],
  "type": "string",
  "description": "* `USR` - user\n* `GIT` - GitHub"
}
object Dashboard 
{
  "type": "object",
  "required": [
    "created_at",
    "created_by",
    "creation_mode",
    "effective_privilege_level",
    "effective_restriction_level",
    "id",
    "is_shared",
    "tiles"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "tags": {
      "type": "array",
      "items": {}
    },
    "tiles": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {}
      },
      "nullable": true,
      "readOnly": true
    },
    "pinned": {
      "type": "boolean"
    },
    "deleted": {
      "type": "boolean"
    },
    "filters": {},
    "is_shared": {
      "type": "boolean",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "$ref": "#/components/schemas/UserBasic"
    },
    "description": {
      "type": "string"
    },
    "use_template": {
      "type": "string",
      "writeOnly": true
    },
    "creation_mode": {
      "$ref": "#/components/schemas/CreationModeEnum"
    },
    "use_dashboard": {
      "type": "integer",
      "nullable": true,
      "writeOnly": true
    },
    "delete_insights": {
      "type": "boolean",
      "default": false,
      "writeOnly": true
    },
    "restriction_level": {
      "$ref": "#/components/schemas/RestrictionLevelEnum"
    },
    "effective_privilege_level": {
      "$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
    },
    "effective_restriction_level": {
      "$ref": "#/components/schemas/EffectiveRestrictionLevelEnum"
    }
  },
  "description": "Serializer mixin that resolves appropriate response for tags depending on license.",
  "x-konfig-properties": {
    "created_by": {
      "readOnly": true
    },
    "creation_mode": {
      "readOnly": true
    },
    "restriction_level": {
      "maximum": 32767,
      "minimum": 0
    },
    "effective_privilege_level": {
      "readOnly": true
    },
    "effective_restriction_level": {
      "readOnly": true
    }
  }
}
object DashboardBasic 
{
  "type": "object",
  "required": [
    "created_at",
    "created_by",
    "creation_mode",
    "deleted",
    "description",
    "effective_privilege_level",
    "effective_restriction_level",
    "id",
    "is_shared",
    "name",
    "pinned",
    "restriction_level"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "tags": {
      "type": "array",
      "items": {}
    },
    "pinned": {
      "type": "boolean",
      "readOnly": true
    },
    "deleted": {
      "type": "boolean",
      "readOnly": true
    },
    "is_shared": {
      "type": "boolean",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "$ref": "#/components/schemas/UserBasic"
    },
    "description": {
      "type": "string",
      "readOnly": true
    },
    "creation_mode": {
      "$ref": "#/components/schemas/CreationModeEnum"
    },
    "restriction_level": {
      "$ref": "#/components/schemas/RestrictionLevelEnum"
    },
    "effective_privilege_level": {
      "$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
    },
    "effective_restriction_level": {
      "$ref": "#/components/schemas/EffectiveRestrictionLevelEnum"
    }
  },
  "description": "Serializer mixin that resolves appropriate response for tags depending on license.",
  "x-konfig-properties": {
    "created_by": {
      "readOnly": true
    },
    "creation_mode": {
      "readOnly": true
    },
    "restriction_level": {
      "readOnly": true
    },
    "effective_privilege_level": {
      "readOnly": true
    },
    "effective_restriction_level": {
      "readOnly": true
    }
  }
}
object DashboardCollaborator 
{
  "type": "object",
  "required": [
    "added_at",
    "dashboard_id",
    "id",
    "level",
    "updated_at",
    "user",
    "user_uuid"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "user": {
      "$ref": "#/components/schemas/UserBasic"
    },
    "level": {
      "$ref": "#/components/schemas/LevelD7eEnum"
    },
    "added_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "user_uuid": {
      "type": "string",
      "format": "uuid",
      "writeOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "dashboard_id": {
      "type": "integer",
      "readOnly": true
    }
  },
  "x-konfig-properties": {
    "user": {
      "readOnly": true
    },
    "level": {
      "maximum": 32767,
      "minimum": 0
    }
  }
}
object DashboardTemplate 
{
  "type": "object",
  "required": [
    "created_at",
    "id",
    "team_id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 255
      },
      "nullable": true
    },
    "scope": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/DashboardTemplateScopeEnum"
        },
        {
          "$ref": "#/components/schemas/BlankEnum"
        },
        {
          "$ref": "#/components/schemas/NullEnum"
        }
      ],
      "nullable": true
    },
    "tiles": {
      "nullable": true
    },
    "deleted": {
      "type": "boolean",
      "nullable": true
    },
    "team_id": {
      "type": "integer",
      "nullable": true,
      "readOnly": true
    },
    "image_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 8201
    },
    "variables": {
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "readOnly": true
    },
    "created_by": {
      "type": "integer",
      "nullable": true
    },
    "template_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "dashboard_filters": {
      "nullable": true
    },
    "dashboard_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    }
  }
}
Load more schemas