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

POST /api/projects/{project_id}/actions

operationId: actions_create

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Action

Property	Type	Required
id	integer	required
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	required
is_action	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
is_calculating	boolean	required
last_calculated_at	string	optional
slack_message_format	string	optional

multipart/form-data

schema Action

Property	Type	Required
id	integer	required
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	required
is_action	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
is_calculating	boolean	required
last_calculated_at	string	optional
slack_message_format	string	optional

application/x-www-form-urlencoded

schema Action

Property	Type	Required
id	integer	required
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	required
is_action	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
is_calculating	boolean	required
last_calculated_at	string	optional
slack_message_format	string	optional

Responses

201 —

POST /api/projects/{project_id}/actions

Activitylog 1 endpoints

POST /api/projects/{project_id}/activity_log/bookmark_activity_notification

operationId: Activitylog_createBookmarkActivityNotification

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

required

application/json

schema ActivityLog

Property	Type	Required
id	string	required
user	object	required
└ 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
scope	string	required
detail	object	optional
unread	boolean	required
item_id	string	optional
activity	string	required
is_system	boolean	optional
created_at	string	optional
organization_id	string	optional
was_impersonated	boolean	optional

multipart/form-data

schema ActivityLog

Property	Type	Required
id	string	required
user	object	required
└ 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
scope	string	required
detail	object	optional
unread	boolean	required
item_id	string	optional
activity	string	required
is_system	boolean	optional
created_at	string	optional
organization_id	string	optional
was_impersonated	boolean	optional

application/x-www-form-urlencoded

schema ActivityLog

Property	Type	Required
id	string	required
user	object	required
└ 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
scope	string	required
detail	object	optional
unread	boolean	required
item_id	string	optional
activity	string	required
is_system	boolean	optional
created_at	string	optional
organization_id	string	optional
was_impersonated	boolean	optional

Responses

200 —

POST /api/projects/{project_id}/activity_log/bookmark_activity_notification

Annotations 1 endpoints

POST /api/projects/{project_id}/annotations

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

operationId: annotations_create

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 Annotation

Property	Type	Required
id	integer	required
scope	string	optional
content	string	optional
deleted	boolean	optional
created_at	string	required
created_by	object	required
└ 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	required
date_marker	string	optional
insight_name	string	required
creation_type	string	optional
dashboard_item	integer	optional
insight_short_id	string	required

multipart/form-data

schema Annotation

Property	Type	Required
id	integer	required
scope	string	optional
content	string	optional
deleted	boolean	optional
created_at	string	required
created_by	object	required
└ 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	required
date_marker	string	optional
insight_name	string	required
creation_type	string	optional
dashboard_item	integer	optional
insight_short_id	string	required

application/x-www-form-urlencoded

schema Annotation

Property	Type	Required
id	integer	required
scope	string	optional
content	string	optional
deleted	boolean	optional
created_at	string	required
created_by	object	required
└ 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	required
date_marker	string	optional
insight_name	string	required
creation_type	string	optional
dashboard_item	integer	optional
insight_short_id	string	required

Responses

201 —

POST /api/projects/{project_id}/annotations

Batchexports 4 endpoints

POST /api/projects/{project_id}/batch_exports

operationId: Batchexports_createNewRun

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

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

201 —

POST /api/projects/{project_id}/batch_exports

POST /api/projects/{project_id}/batch_exports/{id}/backfill

Trigger a backfill for a BatchExport.

operationId: Batchexports_triggerBackfill

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

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

200 —

POST /api/projects/{project_id}/batch_exports/{id}/backfill

POST /api/projects/{project_id}/batch_exports/{id}/pause

Pause a BatchExport.

operationId: Batchexports_pauseAction

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

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

200 —

POST /api/projects/{project_id}/batch_exports/{id}/pause

POST /api/projects/{project_id}/batch_exports/{id}/unpause

Unpause a BatchExport.

operationId: Batchexports_unpauseAction

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

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

200 —

POST /api/projects/{project_id}/batch_exports/{id}/unpause

Cohorts 1 endpoints

POST /api/projects/{project_id}/cohorts

operationId: cohorts_create

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 Cohort

Property	Type	Required
id	integer	required
name	string	optional
count	integer	required
query	object	optional
groups	object	optional
deleted	boolean	optional
filters	object	optional
is_static	boolean	optional
created_at	string	required
created_by	object	required
└ 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	required
last_calculation	string	required
errors_calculating	integer	required

multipart/form-data

schema Cohort

Property	Type	Required
id	integer	required
name	string	optional
count	integer	required
query	object	optional
groups	object	optional
deleted	boolean	optional
filters	object	optional
is_static	boolean	optional
created_at	string	required
created_by	object	required
└ 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	required
last_calculation	string	required
errors_calculating	integer	required

application/x-www-form-urlencoded

schema Cohort

Property	Type	Required
id	integer	required
name	string	optional
count	integer	required
query	object	optional
groups	object	optional
deleted	boolean	optional
filters	object	optional
is_static	boolean	optional
created_at	string	required
created_by	object	required
└ 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	required
last_calculation	string	required
errors_calculating	integer	required

Responses

201 —

POST /api/projects/{project_id}/cohorts

Dashboardtemplates 1 endpoints

POST /api/projects/{project_id}/dashboard_templates

operationId: Dashboardtemplates_createOrUpdate

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 DashboardTemplate

Property	Type	Required
id	string	required
tags	array	optional
scope	object	optional
tiles	object	optional
deleted	boolean	optional
team_id	integer	required
image_url	string	optional
variables	object	optional
created_at	string	required
created_by	integer	optional
template_name	string	optional
dashboard_filters	object	optional
dashboard_description	string	optional

multipart/form-data

schema DashboardTemplate

Property	Type	Required
id	string	required
tags	array	optional
scope	object	optional
tiles	object	optional
deleted	boolean	optional
team_id	integer	required
image_url	string	optional
variables	object	optional
created_at	string	required
created_by	integer	optional
template_name	string	optional
dashboard_filters	object	optional
dashboard_description	string	optional

application/x-www-form-urlencoded

schema DashboardTemplate

Property	Type	Required
id	string	required
tags	array	optional
scope	object	optional
tiles	object	optional
deleted	boolean	optional
team_id	integer	required
image_url	string	optional
variables	object	optional
created_at	string	required
created_by	integer	optional
template_name	string	optional
dashboard_filters	object	optional
dashboard_description	string	optional

Responses

201 —

POST /api/projects/{project_id}/dashboard_templates

Dashboards 3 endpoints

POST /api/projects/{project_id}/dashboards

operationId: dashboards_create

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 Dashboard

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
tiles	array	required
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
is_shared	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
use_dashboard	integer	optional
delete_insights	boolean	optional
restriction_level	integer	optional
effective_privilege_level	integer	required
effective_restriction_level	integer	required

multipart/form-data

schema Dashboard

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
tiles	array	required
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
is_shared	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
use_dashboard	integer	optional
delete_insights	boolean	optional
restriction_level	integer	optional
effective_privilege_level	integer	required
effective_restriction_level	integer	required

application/x-www-form-urlencoded

schema Dashboard

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
tiles	array	required
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
is_shared	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
use_dashboard	integer	optional
delete_insights	boolean	optional
restriction_level	integer	optional
effective_privilege_level	integer	required
effective_restriction_level	integer	required

Responses

201 —

POST /api/projects/{project_id}/dashboards

POST /api/projects/{project_id}/dashboards/create_from_template_json

operationId: Dashboards_createFromTemplateJsonPost

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 Dashboard

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
tiles	array	required
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
is_shared	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
use_dashboard	integer	optional
delete_insights	boolean	optional
restriction_level	integer	optional
effective_privilege_level	integer	required
effective_restriction_level	integer	required

Responses

200 —

POST /api/projects/{project_id}/dashboards/create_from_template_json

POST /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators

operationId: Dashboards_addCollaborator

Parameters

Name	In	Required	Type	Description
dashboard_id	path	required	integer	—
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

required

application/json

schema DashboardCollaborator

Property	Type	Required
id	string	required
user	object	required
└ 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	required
added_at	string	required
user_uuid	string	required
updated_at	string	required
dashboard_id	integer	required

multipart/form-data

schema DashboardCollaborator

Property	Type	Required
id	string	required
user	object	required
└ 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	required
added_at	string	required
user_uuid	string	required
updated_at	string	required
dashboard_id	integer	required

application/x-www-form-urlencoded

schema DashboardCollaborator

Property	Type	Required
id	string	required
user	object	required
└ 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	required
added_at	string	required
user_uuid	string	required
updated_at	string	required
dashboard_id	integer	required

Responses

201 —

POST /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators

Earlyaccessfeature 1 endpoints

POST /api/projects/{project_id}/early_access_feature

operationId: Earlyaccessfeature_createOrUpdate

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

required

application/json

schema EarlyAccessFeatureSerializerCreateOnly

Property	Type	Required
id	string	required
name	string	required
stage	string	required
created_at	string	required
description	string	optional
feature_flag	object	required
└ 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_id	integer	optional
documentation_url	string	optional

multipart/form-data

schema EarlyAccessFeatureSerializerCreateOnly

Property	Type	Required
id	string	required
name	string	required
stage	string	required
created_at	string	required
description	string	optional
feature_flag	object	required
└ 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_id	integer	optional
documentation_url	string	optional

application/x-www-form-urlencoded

schema EarlyAccessFeatureSerializerCreateOnly

Property	Type	Required
id	string	required
name	string	required
stage	string	required
created_at	string	required
description	string	optional
feature_flag	object	required
└ 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_id	integer	optional
documentation_url	string	optional

Responses

201 —

POST /api/projects/{project_id}/early_access_feature

Experiments 1 endpoints

POST /api/projects/{project_id}/experiments

operationId: experiments_create

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

required

application/json

schema Experiment

Property	Type	Required
id	integer	required
name	string	required
filters	object	optional
archived	boolean	optional
end_date	string	optional
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
feature_flag	object	required
└ 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	required
secondary_metrics	object	optional

multipart/form-data

schema Experiment

Property	Type	Required
id	integer	required
name	string	required
filters	object	optional
archived	boolean	optional
end_date	string	optional
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
feature_flag	object	required
└ 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	required
secondary_metrics	object	optional

application/x-www-form-urlencoded

schema Experiment

Property	Type	Required
id	integer	required
name	string	required
filters	object	optional
archived	boolean	optional
end_date	string	optional
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
feature_flag	object	required
└ 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	required
secondary_metrics	object	optional

Responses

201 —

POST /api/projects/{project_id}/experiments

Explicitmembers 1 endpoints

POST /api/projects/{project_id}/explicit_members

operationId: Explicitmembers_createOrUpdateMembers

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

required

application/json

schema ExplicitTeamMember

Property	Type	Required
id	string	required
user	object	required
└ 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	required
user_uuid	string	required
updated_at	string	required
parent_level	integer	required
effective_level	integer	required
parent_membership_id	string	required

multipart/form-data

schema ExplicitTeamMember

Property	Type	Required
id	string	required
user	object	required
└ 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	required
user_uuid	string	required
updated_at	string	required
parent_level	integer	required
effective_level	integer	required
parent_membership_id	string	required

application/x-www-form-urlencoded

schema ExplicitTeamMember

Property	Type	Required
id	string	required
user	object	required
└ 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	required
user_uuid	string	required
updated_at	string	required
parent_level	integer	required
effective_level	integer	required
parent_membership_id	string	required

Responses

201 —

POST /api/projects/{project_id}/explicit_members

Exports 1 endpoints

POST /api/projects/{project_id}/exports

operationId: exports_create

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

required

application/json

schema ExportedAsset

Property	Type	Required
id	integer	required
insight	integer	optional
filename	string	required
dashboard	integer	optional
created_at	string	required
has_content	string	required
expires_after	string	optional
export_format	string	required
export_context	object	optional

multipart/form-data

schema ExportedAsset

Property	Type	Required
id	integer	required
insight	integer	optional
filename	string	required
dashboard	integer	optional
created_at	string	required
has_content	string	required
expires_after	string	optional
export_format	string	required
export_context	object	optional

application/x-www-form-urlencoded

schema ExportedAsset

Property	Type	Required
id	integer	required
insight	integer	optional
filename	string	required
dashboard	integer	optional
created_at	string	required
has_content	string	required
expires_after	string	optional
export_format	string	required
export_context	object	optional

Responses

201 —

POST /api/projects/{project_id}/exports

Featureflags 6 endpoints

POST /api/projects/{project_id}/feature_flags

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_createFeatureFlag

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

required

application/json

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

multipart/form-data

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

application/x-www-form-urlencoded

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

Responses

201 —

POST /api/projects/{project_id}/feature_flags

POST /api/projects/{project_id}/feature_flags/user_blast_radius

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_createFeatureFlagUserBlastRadius

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

required

application/json

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

multipart/form-data

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

application/x-www-form-urlencoded

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/feature_flags/user_blast_radius

POST /api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access

operationId: Featureflags_roleAccessCreate

Parameters

Name	In	Required	Type	Description
feature_flag_id	path	required	integer	—
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

required

application/json

schema FeatureFlagRoleAccess

Property	Type	Required
id	integer	required
role	object	required
└ id	string	required
└ name	string	required
└ members	string	required
└ created_at	string	required
└ created_by	object	required
└ 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	required
└ feature_flags_access_level	integer	optional
role_id	string	required
added_at	string	required
updated_at	string	required
feature_flag	object	required
└ id	integer	required
└ key	string	required
└ name	string	optional
└ tags	array	optional
└ active	boolean	optional
└ deleted	boolean	optional
└ filters	object	optional
└ surveys	object	required
└ can_edit	boolean	required
└ features	object	required
└ created_at	string	optional
└ created_by	object	required
└ 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	required
└ is_simple_flag	boolean	required
└ usage_dashboard	integer	required
└ performed_rollback	boolean	optional
└ rollout_percentage	integer	required
└ rollback_conditions	object	optional
└ analytics_dashboards	array	optional
└ has_enriched_analytics	boolean	optional
└ …1 more	object	optional

multipart/form-data

schema FeatureFlagRoleAccess

Property	Type	Required
id	integer	required
role	object	required
└ id	string	required
└ name	string	required
└ members	string	required
└ created_at	string	required
└ created_by	object	required
└ 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	required
└ feature_flags_access_level	integer	optional
role_id	string	required
added_at	string	required
updated_at	string	required
feature_flag	object	required
└ id	integer	required
└ key	string	required
└ name	string	optional
└ tags	array	optional
└ active	boolean	optional
└ deleted	boolean	optional
└ filters	object	optional
└ surveys	object	required
└ can_edit	boolean	required
└ features	object	required
└ created_at	string	optional
└ created_by	object	required
└ 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	required
└ is_simple_flag	boolean	required
└ usage_dashboard	integer	required
└ performed_rollback	boolean	optional
└ rollout_percentage	integer	required
└ rollback_conditions	object	optional
└ analytics_dashboards	array	optional
└ has_enriched_analytics	boolean	optional
└ …1 more	object	optional

application/x-www-form-urlencoded

schema FeatureFlagRoleAccess

Property	Type	Required
id	integer	required
role	object	required
└ id	string	required
└ name	string	required
└ members	string	required
└ created_at	string	required
└ created_by	object	required
└ 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	required
└ feature_flags_access_level	integer	optional
role_id	string	required
added_at	string	required
updated_at	string	required
feature_flag	object	required
└ id	integer	required
└ key	string	required
└ name	string	optional
└ tags	array	optional
└ active	boolean	optional
└ deleted	boolean	optional
└ filters	object	optional
└ surveys	object	required
└ can_edit	boolean	required
└ features	object	required
└ created_at	string	optional
└ created_by	object	required
└ 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	required
└ is_simple_flag	boolean	required
└ usage_dashboard	integer	required
└ performed_rollback	boolean	optional
└ rollout_percentage	integer	required
└ rollback_conditions	object	optional
└ analytics_dashboards	array	optional
└ has_enriched_analytics	boolean	optional
└ …1 more	object	optional

Responses

201 —

POST /api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access

POST /api/projects/{project_id}/feature_flags/{id}/create_static_cohort_for_flag

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_createStaticCohortForFlag

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

required

application/json

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

multipart/form-data

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

application/x-www-form-urlencoded

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/feature_flags/{id}/create_static_cohort_for_flag

POST /api/projects/{project_id}/feature_flags/{id}/dashboard

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_createOrUpdateDashboard

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

required

application/json

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

multipart/form-data

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

application/x-www-form-urlencoded

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/feature_flags/{id}/dashboard

POST /api/projects/{project_id}/feature_flags/{id}/enrich_usage_dashboard

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_enrichUsageDashboardCreate

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

required

application/json

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

multipart/form-data

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

application/x-www-form-urlencoded

schema FeatureFlag

Property	Type	Required
id	integer	required
key	string	required
name	string	optional
tags	array	optional
active	boolean	optional
deleted	boolean	optional
filters	object	optional
surveys	object	required
can_edit	boolean	required
features	object	required
created_at	string	optional
created_by	object	required
└ 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	required
is_simple_flag	boolean	required
usage_dashboard	integer	required
performed_rollback	boolean	optional
rollout_percentage	integer	required
rollback_conditions	object	optional
analytics_dashboards	array	optional
has_enriched_analytics	boolean	optional
…1 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/feature_flags/{id}/enrich_usage_dashboard

Funnel 1 endpoints

POST /api/projects/{project_id}/insights/funnel

operationId: Funnel_createOrUpdate

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Funnel

Property	Type	Required
events	array	optional
└ id	string	required
└ math	string	optional
└ properties	array	optional
└ type	string	optional
└ values	array	required
└ key	string	required
└ type	object	optional
└ value	string	required
└ operator	object	optional
actions	array	optional
└ id	string	required
└ math	string	optional
└ properties	array	optional
└ type	string	optional
└ values	array	required
└ key	string	required
└ type	object	optional
└ value	string	required
└ operator	object	optional
date_to	string	optional
breakdown	string	optional
date_from	string	optional
exclusions	array	optional
└ id	string	required
└ properties	object	optional
└ type	string	optional
└ values	array	required
└ key	string	required
└ type	object	optional
└ value	string	required
└ operator	object	optional
└ funnel_to_step	integer	optional
└ funnel_from_step	integer	optional
properties	object	optional
└ type	string	optional
└ values	array	required
└ key	string	required
└ type	object	optional
└ value	string	required
└ operator	object	optional
breakdown_type	string	optional
breakdown_limit	integer	optional
funnel_viz_type	string	optional
funnel_order_type	string	optional
funnel_window_days	integer	optional
filter_test_accounts	boolean	optional
funnel_window_interval	integer	optional
funnel_window_interval_type	string	optional
aggregation_group_type_index	integer	optional

Responses

200

Note, if funnel_viz_type is set the response will be different.

POST /api/projects/{project_id}/insights/funnel

Insights 7 endpoints

POST /api/projects/{project_id}/insights

operationId: insights_create

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Insight

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
order	integer	optional
query	object	optional
saved	boolean	optional
result	string	required
deleted	boolean	optional
filters	object	optional
short_id	string	required
timezone	string	required
favorited	boolean	optional
is_cached	string	required
is_sample	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
derived_name	string	optional
…7 more	object	optional

Responses

201 —

POST /api/projects/{project_id}/insights

POST /api/projects/{project_id}/insights/cancel

operationId: Insights_cancelCreate

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Insight

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
order	integer	optional
query	object	optional
saved	boolean	optional
result	string	required
deleted	boolean	optional
filters	object	optional
short_id	string	required
timezone	string	required
favorited	boolean	optional
is_cached	string	required
is_sample	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
derived_name	string	optional
…7 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/insights/cancel

POST /api/projects/{project_id}/insights/funnel/correlation

operationId: Insights_funnelCorrelationCreate

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Insight

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
order	integer	optional
query	object	optional
saved	boolean	optional
result	string	required
deleted	boolean	optional
filters	object	optional
short_id	string	required
timezone	string	required
favorited	boolean	optional
is_cached	string	required
is_sample	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
derived_name	string	optional
…7 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/insights/funnel/correlation

POST /api/projects/{project_id}/insights/path

operationId: Insights_createOrUpdatePath

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Insight

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
order	integer	optional
query	object	optional
saved	boolean	optional
result	string	required
deleted	boolean	optional
filters	object	optional
short_id	string	required
timezone	string	required
favorited	boolean	optional
is_cached	string	required
is_sample	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
derived_name	string	optional
…7 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/insights/path

POST /api/projects/{project_id}/insights/retention

operationId: Insights_createRetention

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Insight

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
order	integer	optional
query	object	optional
saved	boolean	optional
result	string	required
deleted	boolean	optional
filters	object	optional
short_id	string	required
timezone	string	required
favorited	boolean	optional
is_cached	string	required
is_sample	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
derived_name	string	optional
…7 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/insights/retention

POST /api/projects/{project_id}/insights/timing

operationId: Insights_createTimingInsight

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Insight

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
order	integer	optional
query	object	optional
saved	boolean	optional
result	string	required
deleted	boolean	optional
filters	object	optional
short_id	string	required
timezone	string	required
favorited	boolean	optional
is_cached	string	required
is_sample	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
derived_name	string	optional
…7 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/insights/timing

POST /api/projects/{project_id}/insights/{id}/viewed

operationId: Insights_markAsViewed

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 Insight

Property	Type	Required
id	integer	required
name	string	optional
tags	array	optional
order	integer	optional
query	object	optional
saved	boolean	optional
result	string	required
deleted	boolean	optional
filters	object	optional
short_id	string	required
timezone	string	required
favorited	boolean	optional
is_cached	string	required
is_sample	boolean	required
created_at	string	required
created_by	object	required
└ 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	required
description	string	optional
derived_name	string	optional
…7 more	object	optional

Responses

200 —

POST /api/projects/{project_id}/insights/{id}/viewed

Notebooks 1 endpoints

POST /api/projects/{project_id}/notebooks

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

operationId: notebooks_create

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 Notebook

Property	Type	Required
id	string	required
title	string	optional
content	object	optional
deleted	boolean	optional
version	integer	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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 Notebook

Property	Type	Required
id	string	required
title	string	optional
content	object	optional
deleted	boolean	optional
version	integer	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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 Notebook

Property	Type	Required
id	string	required
title	string	optional
content	object	optional
deleted	boolean	optional
version	integer	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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

201 —

POST /api/projects/{project_id}/notebooks

Organizations 22 endpoints

POST /api/organizations

operationId: Organizations_createOrganization

Request Body

required

application/json

schema Organization

Property	Type	Required
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

multipart/form-data

schema Organization

Property	Type	Required
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

application/x-www-form-urlencoded

schema Organization

Property	Type	Required
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

Responses

201 —

POST /api/organizations

POST /api/organizations/{organization_id}/batch_exports

operationId: Organizations_createBatchExport

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

201 —

POST /api/organizations/{organization_id}/batch_exports

POST /api/organizations/{organization_id}/batch_exports/{id}/backfill

Trigger a backfill for a BatchExport.

operationId: Organizations_triggerBackfill

Parameters

Name	In	Required	Type	Description
id	path	required	string	A UUID string identifying this batch export.
organization_id	path	required	string	—

Request Body

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

200 —

POST /api/organizations/{organization_id}/batch_exports/{id}/backfill

POST /api/organizations/{organization_id}/batch_exports/{id}/pause

Pause a BatchExport.

operationId: Organizations_pauseBatchExport

Parameters

Name	In	Required	Type	Description
id	path	required	string	A UUID string identifying this batch export.
organization_id	path	required	string	—

Request Body

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

200 —

POST /api/organizations/{organization_id}/batch_exports/{id}/pause

POST /api/organizations/{organization_id}/batch_exports/{id}/unpause

Unpause a BatchExport.

operationId: Organizations_unpauseBatchExport

Parameters

Name	In	Required	Type	Description
id	path	required	string	A UUID string identifying this batch export.
organization_id	path	required	string	—

Request Body

required

application/json

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

multipart/form-data

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

application/x-www-form-urlencoded

schema BatchExport

Property	Type	Required
id	string	required
name	string	required
end_at	string	optional
paused	boolean	optional
schema	object	required
team_id	integer	required
interval	string	required
start_at	string	optional
created_at	string	required
destination	object	required
└ type	string	required
└ config	object	optional
hogql_query	string	optional
latest_runs	array	required
└ 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	required

Responses

200 —

POST /api/organizations/{organization_id}/batch_exports/{id}/unpause

POST /api/organizations/{organization_id}/domains

operationId: domains_create

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

required

application/json

schema OrganizationDomain

Property	Type	Required
id	string	required
domain	string	required
has_saml	boolean	required
is_verified	boolean	required
verified_at	string	required
saml_acs_url	string	optional
saml_entity_id	string	optional
saml_x509_cert	string	optional
sso_enforcement	string	optional
verification_challenge	string	required
jit_provisioning_enabled	boolean	optional

multipart/form-data

schema OrganizationDomain

Property	Type	Required
id	string	required
domain	string	required
has_saml	boolean	required
is_verified	boolean	required
verified_at	string	required
saml_acs_url	string	optional
saml_entity_id	string	optional
saml_x509_cert	string	optional
sso_enforcement	string	optional
verification_challenge	string	required
jit_provisioning_enabled	boolean	optional

application/x-www-form-urlencoded

schema OrganizationDomain

Property	Type	Required
id	string	required
domain	string	required
has_saml	boolean	required
is_verified	boolean	required
verified_at	string	required
saml_acs_url	string	optional
saml_entity_id	string	optional
saml_x509_cert	string	optional
sso_enforcement	string	optional
verification_challenge	string	required
jit_provisioning_enabled	boolean	optional

Responses

201 —

POST /api/organizations/{organization_id}/domains

POST /api/organizations/{organization_id}/domains/{id}/verify

operationId: Organizations_verifyDomainPost

Parameters

Name	In	Required	Type	Description
id	path	required	string	A UUID string identifying this domain.
organization_id	path	required	string	—

Request Body

required

application/json

schema OrganizationDomain

Property	Type	Required
id	string	required
domain	string	required
has_saml	boolean	required
is_verified	boolean	required
verified_at	string	required
saml_acs_url	string	optional
saml_entity_id	string	optional
saml_x509_cert	string	optional
sso_enforcement	string	optional
verification_challenge	string	required
jit_provisioning_enabled	boolean	optional

multipart/form-data

schema OrganizationDomain

Property	Type	Required
id	string	required
domain	string	required
has_saml	boolean	required
is_verified	boolean	required
verified_at	string	required
saml_acs_url	string	optional
saml_entity_id	string	optional
saml_x509_cert	string	optional
sso_enforcement	string	optional
verification_challenge	string	required
jit_provisioning_enabled	boolean	optional

application/x-www-form-urlencoded

schema OrganizationDomain

Property	Type	Required
id	string	required
domain	string	required
has_saml	boolean	required
is_verified	boolean	required
verified_at	string	required
saml_acs_url	string	optional
saml_entity_id	string	optional
saml_x509_cert	string	optional
sso_enforcement	string	optional
verification_challenge	string	required
jit_provisioning_enabled	boolean	optional

Responses

200 —

POST /api/organizations/{organization_id}/domains/{id}/verify

POST /api/organizations/{organization_id}/invites

operationId: invites_create

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

required

application/json

schema OrganizationInvite

Property	Type	Required
id	string	required
message	string	optional
created_at	string	required
created_by	object	required
└ 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
first_name	string	optional
is_expired	boolean	required
updated_at	string	required
target_email	string	required
emailing_attempt_made	boolean	required

multipart/form-data

schema OrganizationInvite

Property	Type	Required
id	string	required
message	string	optional
created_at	string	required
created_by	object	required
└ 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
first_name	string	optional
is_expired	boolean	required
updated_at	string	required
target_email	string	required
emailing_attempt_made	boolean	required

application/x-www-form-urlencoded

schema OrganizationInvite

Property	Type	Required
id	string	required
message	string	optional
created_at	string	required
created_by	object	required
└ 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
first_name	string	optional
is_expired	boolean	required
updated_at	string	required
target_email	string	required
emailing_attempt_made	boolean	required

Responses

201 —

POST /api/organizations/{organization_id}/invites

POST /api/organizations/{organization_id}/invites/bulk

operationId: Organizations_bulkInviteCreate

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

required

application/json

schema OrganizationInvite

Property	Type	Required
id	string	required
message	string	optional
created_at	string	required
created_by	object	required
└ 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
first_name	string	optional
is_expired	boolean	required
updated_at	string	required
target_email	string	required
emailing_attempt_made	boolean	required

multipart/form-data

schema OrganizationInvite

Property	Type	Required
id	string	required
message	string	optional
created_at	string	required
created_by	object	required
└ 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
first_name	string	optional
is_expired	boolean	required
updated_at	string	required
target_email	string	required
emailing_attempt_made	boolean	required

application/x-www-form-urlencoded

schema OrganizationInvite

Property	Type	Required
id	string	required
message	string	optional
created_at	string	required
created_by	object	required
└ 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
first_name	string	optional
is_expired	boolean	required
updated_at	string	required
target_email	string	required
emailing_attempt_made	boolean	required

Responses

200 —

POST /api/organizations/{organization_id}/invites/bulk

POST /api/organizations/{organization_id}/pipeline_destinations

operationId: Organizations_createPipelineDestinations

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

application/json

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

201 —

POST /api/organizations/{organization_id}/pipeline_destinations

POST /api/organizations/{organization_id}/pipeline_destinations/{id}/upgrade

operationId: Organizations_upgradePipelineDestination

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 Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

200 —

POST /api/organizations/{organization_id}/pipeline_destinations/{id}/upgrade

POST /api/organizations/{organization_id}/pipeline_frontend_apps

operationId: Organizations_createPipelineFrontendApps

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

application/json

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

201 —

POST /api/organizations/{organization_id}/pipeline_frontend_apps

POST /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/upgrade

operationId: Organizations_upgradePipelineFrontendApp

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 Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

200 —

POST /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/upgrade

POST /api/organizations/{organization_id}/pipeline_import_apps

operationId: Organizations_importPipelineApps

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

application/json

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

201 —

POST /api/organizations/{organization_id}/pipeline_import_apps

POST /api/organizations/{organization_id}/pipeline_import_apps/{id}/upgrade

operationId: Organizations_upgradePipelineImportApp

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 Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

200 —

POST /api/organizations/{organization_id}/pipeline_import_apps/{id}/upgrade

POST /api/organizations/{organization_id}/pipeline_transformations

operationId: Organizations_createPipelineTransformation

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

application/json

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

201 —

POST /api/organizations/{organization_id}/pipeline_transformations

POST /api/organizations/{organization_id}/pipeline_transformations/{id}/upgrade

operationId: Organizations_upgradePipelineTransformation

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 Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

200 —

POST /api/organizations/{organization_id}/pipeline_transformations/{id}/upgrade

POST /api/organizations/{organization_id}/plugins

operationId: plugins_create

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

application/json

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

201 —

POST /api/organizations/{organization_id}/plugins

POST /api/organizations/{organization_id}/plugins/{id}/upgrade

operationId: Organizations_upgradePlugin

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 Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

multipart/form-data

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

application/x-www-form-urlencoded

schema Plugin

Property	Type	Required
id	integer	required
tag	string	optional
url	string	required
icon	string	optional
name	string	optional
metrics	object	optional
is_global	boolean	optional
latest_tag	string	required
description	string	optional
plugin_type	object	optional
public_jobs	object	optional
capabilities	object	optional
config_schema	object	optional
organization_id	string	required
organization_name	string	required

Responses

200 —

POST /api/organizations/{organization_id}/plugins/{id}/upgrade

POST /api/organizations/{organization_id}/projects

Projects for the current organization.

operationId: Organizations_createProject

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

application/json

schema Team

Property	Type	Required
id	integer	required
name	string	optional
uuid	string	required
is_demo	boolean	optional
app_urls	array	optional
timezone	string	optional
api_token	string	required
created_at	string	required
updated_at	string	required
organization	string	required
anonymize_ips	boolean	optional
access_control	boolean	optional
extra_settings	object	optional
ingested_event	boolean	required
surveys_opt_in	boolean	optional
week_start_day	object	optional
data_attributes	object	optional
has_group_types	boolean	required
inject_web_apps	boolean	optional
primary_dashboard	integer	optional
…24 more	object	optional

multipart/form-data

schema Team

Property	Type	Required
id	integer	required
name	string	optional
uuid	string	required
is_demo	boolean	optional
app_urls	array	optional
timezone	string	optional
api_token	string	required
created_at	string	required
updated_at	string	required
organization	string	required
anonymize_ips	boolean	optional
access_control	boolean	optional
extra_settings	object	optional
ingested_event	boolean	required
surveys_opt_in	boolean	optional
week_start_day	object	optional
data_attributes	object	optional
has_group_types	boolean	required
inject_web_apps	boolean	optional
primary_dashboard	integer	optional
…24 more	object	optional

application/x-www-form-urlencoded

schema Team

Property	Type	Required
id	integer	required
name	string	optional
uuid	string	required
is_demo	boolean	optional
app_urls	array	optional
timezone	string	optional
api_token	string	required
created_at	string	required
updated_at	string	required
organization	string	required
anonymize_ips	boolean	optional
access_control	boolean	optional
extra_settings	object	optional
ingested_event	boolean	required
surveys_opt_in	boolean	optional
week_start_day	object	optional
data_attributes	object	optional
has_group_types	boolean	required
inject_web_apps	boolean	optional
primary_dashboard	integer	optional
…24 more	object	optional

Responses

201 —

POST /api/organizations/{organization_id}/projects

POST /api/organizations/{organization_id}/roles

operationId: roles_create

Parameters

Name	In	Required	Type	Description
organization_id	path	required	string	—

Request Body

required

application/json

schema Role

Property	Type	Required
id	string	required
name	string	required
members	string	required
created_at	string	required
created_by	object	required
└ 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	required
feature_flags_access_level	integer	optional

multipart/form-data

schema Role

Property	Type	Required
id	string	required
name	string	required
members	string	required
created_at	string	required
created_by	object	required
└ 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	required
feature_flags_access_level	integer	optional

application/x-www-form-urlencoded

schema Role

Property	Type	Required
id	string	required
name	string	required
members	string	required
created_at	string	required
created_by	object	required
└ 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	required
feature_flags_access_level	integer	optional

Responses

201 —

POST /api/organizations/{organization_id}/roles

POST /api/organizations/{organization_id}/roles/{role_id}/role_memberships

operationId: Organizations_createRoleMemberships

Parameters

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

Request Body

required

application/json

schema RoleMembership

Property	Type	Required
id	string	required
user	object	required
└ 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
role_id	string	required
joined_at	string	required
user_uuid	string	required
updated_at	string	required
organization_member	object	required
└ id	string	required
└ user	object	required
└ 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	required
└ updated_at	string	required
└ is_2fa_enabled	boolean	required
└ has_social_auth	boolean	required

multipart/form-data

schema RoleMembership

Property	Type	Required
id	string	required
user	object	required
└ 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
role_id	string	required
joined_at	string	required
user_uuid	string	required
updated_at	string	required
organization_member	object	required
└ id	string	required
└ user	object	required
└ 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	required
└ updated_at	string	required
└ is_2fa_enabled	boolean	required
└ has_social_auth	boolean	required

application/x-www-form-urlencoded

schema RoleMembership

Property	Type	Required
id	string	required
user	object	required
└ 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
role_id	string	required
joined_at	string	required
user_uuid	string	required
updated_at	string	required
organization_member	object	required
└ id	string	required
└ user	object	required
└ 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	required
└ updated_at	string	required
└ is_2fa_enabled	boolean	required
└ has_social_auth	boolean	required

Responses

201 —

POST /api/organizations/{organization_id}/roles/{role_id}/role_memberships

Persons 6 endpoints

POST /api/projects/{project_id}/persons/funnel

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_createOrUpdateFunnel

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

multipart/form-data

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

application/x-www-form-urlencoded

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

Responses

200 —

POST /api/projects/{project_id}/persons/funnel

POST /api/projects/{project_id}/persons/funnel/correlation

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_createOrUpdateFunnelCorrelation

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

multipart/form-data

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

application/x-www-form-urlencoded

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

Responses

200 —

POST /api/projects/{project_id}/persons/funnel/correlation

POST /api/projects/{project_id}/persons/path

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_createOrUpdatePath

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

multipart/form-data

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

application/x-www-form-urlencoded

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

Responses

200 —

POST /api/projects/{project_id}/persons/path

POST /api/projects/{project_id}/persons/{id}/delete_property

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_deletePropertyApi

Parameters

Name	In	Required	Type	Description
$unset	query	required	string	Specify the property key to delete
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 Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

multipart/form-data

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

application/x-www-form-urlencoded

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

Responses

200 —

POST /api/projects/{project_id}/persons/{id}/delete_property

POST /api/projects/{project_id}/persons/{id}/split

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_createOrUpdateSplit

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 Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

multipart/form-data

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

application/x-www-form-urlencoded

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

Responses

200 —

POST /api/projects/{project_id}/persons/{id}/split

POST /api/projects/{project_id}/persons/{id}/update_property

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_createOrUpdateProperty

Parameters

Name	In	Required	Type	Description
format	query	optional	string	—
id	path	required	integer	A unique integer value identifying this person.
key	query	required	string	Specify the property key
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/.
value	query	required		Specify the property value

Request Body

application/json

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

multipart/form-data

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

application/x-www-form-urlencoded

schema Person

Property	Type	Required
id	integer	required
name	string	required
uuid	string	required
created_at	string	required
properties	object	optional
distinct_ids	array	required

Responses

200 —

POST /api/projects/{project_id}/persons/{id}/update_property

Pipelinedestinationconfigs 2 endpoints

POST /api/projects/{project_id}/pipeline_destination_configs

operationId: Pipelinedestinationconfigs_createOrUpdate

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

201 —

POST /api/projects/{project_id}/pipeline_destination_configs

POST /api/projects/{project_id}/pipeline_destination_configs/{id}/job

operationId: Pipelinedestinationconfigs_createJob

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

200 —

POST /api/projects/{project_id}/pipeline_destination_configs/{id}/job

Pipelinefrontendappsconfigs 2 endpoints

POST /api/projects/{project_id}/pipeline_frontend_apps_configs

operationId: Pipelinefrontendappsconfigs_createOrUpdate

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

201 —

POST /api/projects/{project_id}/pipeline_frontend_apps_configs

POST /api/projects/{project_id}/pipeline_frontend_apps_configs/{id}/job

operationId: Pipelinefrontendappsconfigs_createJob

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

200 —

POST /api/projects/{project_id}/pipeline_frontend_apps_configs/{id}/job

Pipelineimportappsconfigs 2 endpoints

POST /api/projects/{project_id}/pipeline_import_apps_configs

operationId: Pipelineimportappsconfigs_postPipelineImportAppsConfigs

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

201 —

POST /api/projects/{project_id}/pipeline_import_apps_configs

POST /api/projects/{project_id}/pipeline_import_apps_configs/{id}/job

operationId: Pipelineimportappsconfigs_createJob

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

200 —

POST /api/projects/{project_id}/pipeline_import_apps_configs/{id}/job

Pipelinetransformationconfigs 2 endpoints

POST /api/projects/{project_id}/pipeline_transformation_configs

operationId: Pipelinetransformationconfigs_createOrUpdate

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

201 —

POST /api/projects/{project_id}/pipeline_transformation_configs

POST /api/projects/{project_id}/pipeline_transformation_configs/{id}/job

operationId: Pipelinetransformationconfigs_createJob

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

200 —

POST /api/projects/{project_id}/pipeline_transformation_configs/{id}/job

Pluginconfigs 2 endpoints

POST /api/projects/{project_id}/plugin_configs

operationId: Pluginconfigs_createOrUpdate

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

201 —

POST /api/projects/{project_id}/plugin_configs

POST /api/projects/{project_id}/plugin_configs/{id}/job

operationId: Pluginconfigs_createJob

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

required

application/json

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

multipart/form-data

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

application/x-www-form-urlencoded

schema PluginConfig

Property	Type	Required
id	integer	required
name	string	optional
error	string	required
order	integer	required
config	string	required
plugin	integer	required
deleted	boolean	optional
enabled	boolean	optional
team_id	integer	required
created_at	string	required
updated_at	string	required
description	string	optional
plugin_info	string	required
delivery_rate_24h	string	required

Responses

200 —

POST /api/projects/{project_id}/plugin_configs/{id}/job

Query 1 endpoints

POST /api/projects/{project_id}/query

operationId: query_create

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

required

application/json

schema QueryRequest

Property	Type	Required
async	boolean	optional
query	object	required
refresh	boolean	optional
client_query_id	string	optional

multipart/form-data

schema QueryRequest

Property	Type	Required
async	boolean	optional
query	object	required
refresh	boolean	optional
client_query_id	string	optional

application/x-www-form-urlencoded

schema QueryRequest

Property	Type	Required
async	boolean	optional
query	object	required
refresh	boolean	optional
client_query_id	string	optional

Responses

200 —

POST /api/projects/{project_id}/query

Sessionrecordingplaylists 2 endpoints

POST /api/projects/{project_id}/session_recording_playlists

operationId: Sessionrecordingplaylists_createOrUpdate

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 SessionRecordingPlaylist

Property	Type	Required
id	integer	required
name	string	optional
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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 SessionRecordingPlaylist

Property	Type	Required
id	integer	required
name	string	optional
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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 SessionRecordingPlaylist

Property	Type	Required
id	integer	required
name	string	optional
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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

201 —

POST /api/projects/{project_id}/session_recording_playlists

POST /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}

operationId: Sessionrecordingplaylists_createRecording

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/.
session_recording_id	path	required	string	—
short_id	path	required	string	—

Request Body

application/json

schema SessionRecordingPlaylist

Property	Type	Required
id	integer	required
name	string	optional
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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 SessionRecordingPlaylist

Property	Type	Required
id	integer	required
name	string	optional
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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 SessionRecordingPlaylist

Property	Type	Required
id	integer	required
name	string	optional
pinned	boolean	optional
deleted	boolean	optional
filters	object	optional
short_id	string	required
created_at	string	required
created_by	object	required
└ 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	required
last_modified_by	object	required
└ 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 —

POST /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}

Sessionrecordings 2 endpoints

POST /api/projects/{project_id}/session_recordings/{id}/persist

operationId: Sessionrecordings_persistSessionRecording

Parameters

Name	In	Required	Type	Description
id	path	required	string	A UUID string identifying this session recording.
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 SessionRecording

Property	Type	Required
id	string	required
person	object	optional
└ id	integer	required
└ name	string	required
└ uuid	string	required
└ created_at	string	required
└ properties	object	optional
└ distinct_ids	string	required
viewed	string	required
storage	string	required
end_time	string	required
start_url	string	required
start_time	string	required
click_count	integer	required
distinct_id	string	required
active_seconds	integer	required
keypress_count	integer	required
inactive_seconds	integer	required
console_log_count	integer	required
console_warn_count	integer	required
recording_duration	integer	required
console_error_count	integer	required
mouse_activity_count	integer	required

multipart/form-data

schema SessionRecording

Property	Type	Required
id	string	required
person	object	optional
└ id	integer	required
└ name	string	required
└ uuid	string	required
└ created_at	string	required
└ properties	object	optional
└ distinct_ids	string	required
viewed	string	required
storage	string	required
end_time	string	required
start_url	string	required
start_time	string	required
click_count	integer	required
distinct_id	string	required
active_seconds	integer	required
keypress_count	integer	required
inactive_seconds	integer	required
console_log_count	integer	required
console_warn_count	integer	required
recording_duration	integer	required
console_error_count	integer	required
mouse_activity_count	integer	required

application/x-www-form-urlencoded

schema SessionRecording

Property	Type	Required
id	string	required
person	object	optional
└ id	integer	required
└ name	string	required
└ uuid	string	required
└ created_at	string	required
└ properties	object	optional
└ distinct_ids	string	required
viewed	string	required
storage	string	required
end_time	string	required
start_url	string	required
start_time	string	required
click_count	integer	required
distinct_id	string	required
active_seconds	integer	required
keypress_count	integer	required
inactive_seconds	integer	required
console_log_count	integer	required
console_warn_count	integer	required
recording_duration	integer	required
console_error_count	integer	required
mouse_activity_count	integer	required

Responses

200 —

POST /api/projects/{project_id}/session_recordings/{id}/persist

POST /api/projects/{project_id}/session_recordings/{id}/summarize

operationId: Sessionrecordings_summarizeCreate

Parameters

Name	In	Required	Type	Description
id	path	required	string	A UUID string identifying this session recording.
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 SessionRecording

Property	Type	Required
id	string	required
person	object	optional
└ id	integer	required
└ name	string	required
└ uuid	string	required
└ created_at	string	required
└ properties	object	optional
└ distinct_ids	string	required
viewed	string	required
storage	string	required
end_time	string	required
start_url	string	required
start_time	string	required
click_count	integer	required
distinct_id	string	required
active_seconds	integer	required
keypress_count	integer	required
inactive_seconds	integer	required
console_log_count	integer	required
console_warn_count	integer	required
recording_duration	integer	required
console_error_count	integer	required
mouse_activity_count	integer	required

multipart/form-data

schema SessionRecording

Property	Type	Required
id	string	required
person	object	optional
└ id	integer	required
└ name	string	required
└ uuid	string	required
└ created_at	string	required
└ properties	object	optional
└ distinct_ids	string	required
viewed	string	required
storage	string	required
end_time	string	required
start_url	string	required
start_time	string	required
click_count	integer	required
distinct_id	string	required
active_seconds	integer	required
keypress_count	integer	required
inactive_seconds	integer	required
console_log_count	integer	required
console_warn_count	integer	required
recording_duration	integer	required
console_error_count	integer	required
mouse_activity_count	integer	required

application/x-www-form-urlencoded

schema SessionRecording

Property	Type	Required
id	string	required
person	object	optional
└ id	integer	required
└ name	string	required
└ uuid	string	required
└ created_at	string	required
└ properties	object	optional
└ distinct_ids	string	required
viewed	string	required
storage	string	required
end_time	string	required
start_url	string	required
start_time	string	required
click_count	integer	required
distinct_id	string	required
active_seconds	integer	required
keypress_count	integer	required
inactive_seconds	integer	required
console_log_count	integer	required
console_warn_count	integer	required
recording_duration	integer	required
console_error_count	integer	required
mouse_activity_count	integer	required

Responses

200 —

POST /api/projects/{project_id}/session_recordings/{id}/summarize

Subscriptions 1 endpoints

POST /api/projects/{project_id}/subscriptions

operationId: subscriptions_create

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

required

application/json

schema Subscription

Property	Type	Required
id	integer	required
count	integer	optional
title	string	optional
deleted	boolean	optional
insight	integer	optional
summary	string	required
bysetpos	integer	optional
interval	integer	optional
byweekday	array	optional
dashboard	integer	optional
frequency	string	required
created_at	string	required
created_by	object	required
└ 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	required
until_date	string	optional
target_type	string	required
target_value	string	required
invite_message	string	optional
next_delivery_date	string	required

multipart/form-data

schema Subscription

Property	Type	Required
id	integer	required
count	integer	optional
title	string	optional
deleted	boolean	optional
insight	integer	optional
summary	string	required
bysetpos	integer	optional
interval	integer	optional
byweekday	array	optional
dashboard	integer	optional
frequency	string	required
created_at	string	required
created_by	object	required
└ 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	required
until_date	string	optional
target_type	string	required
target_value	string	required
invite_message	string	optional
next_delivery_date	string	required

application/x-www-form-urlencoded

schema Subscription

Property	Type	Required
id	integer	required
count	integer	optional
title	string	optional
deleted	boolean	optional
insight	integer	optional
summary	string	required
bysetpos	integer	optional
interval	integer	optional
byweekday	array	optional
dashboard	integer	optional
frequency	string	required
created_at	string	required
created_by	object	required
└ 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	required
until_date	string	optional
target_type	string	required
target_value	string	required
invite_message	string	optional
next_delivery_date	string	required

Responses

201 —

POST /api/projects/{project_id}/subscriptions

Surveys 1 endpoints

POST /api/projects/{project_id}/surveys

operationId: surveys_create

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

required

application/json

schema SurveySerializerCreateUpdateOnly

Property	Type	Required
id	string	required
name	string	required
type	string	required
archived	boolean	optional
end_date	string	optional
questions	object	optional
appearance	object	optional
conditions	object	optional
created_at	string	required
created_by	object	required
└ 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	required
└ 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	required
└ 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 SurveySerializerCreateUpdateOnly

Property	Type	Required
id	string	required
name	string	required
type	string	required
archived	boolean	optional
end_date	string	optional
questions	object	optional
appearance	object	optional
conditions	object	optional
created_at	string	required
created_by	object	required
└ 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	required
└ 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	required
└ 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 SurveySerializerCreateUpdateOnly

Property	Type	Required
id	string	required
name	string	required
type	string	required
archived	boolean	optional
end_date	string	optional
questions	object	optional
appearance	object	optional
conditions	object	optional
created_at	string	required
created_by	object	required
└ 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	required
└ 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	required
└ 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

201 —

POST /api/projects/{project_id}/surveys

Trend 1 endpoints

POST /api/projects/{project_id}/insights/trend

operationId: Trend_createOrUpdatePath

Parameters

Name	In	Required	Type	Description
format	query	optional	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 Trend

Property	Type	Required
events	array	optional
└ id	string	required
└ math	string	optional
└ properties	array	optional
└ type	string	optional
└ values	array	required
└ key	string	required
└ type	object	optional
└ value	string	required
└ operator	object	optional
actions	array	optional
└ id	string	required
└ math	string	optional
└ properties	array	optional
└ type	string	optional
└ values	array	required
└ key	string	required
└ type	object	optional
└ value	string	required
└ operator	object	optional
compare	boolean	optional
date_to	string	optional
display	string	optional
formula	string	optional
breakdown	string	optional
date_from	string	optional
properties	object	optional
└ type	string	optional
└ values	array	required
└ key	string	required
└ type	object	optional
└ value	string	required
└ operator	object	optional
breakdown_type	string	optional
filter_test_accounts	boolean	optional

Responses

200 —

POST /api/projects/{project_id}/insights/trend

Users 4 endpoints

POST /api/users/{uuid}/request_email_verification

operationId: Users_requestEmailVerificationCreate

Parameters

Name	In	Required	Type	Description
uuid	path	required	string	—

Request Body

required

application/json

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

multipart/form-data

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

application/x-www-form-urlencoded

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

Responses

200 —

POST /api/users/{uuid}/request_email_verification

POST /api/users/{uuid}/scene_personalisation

operationId: Users_createScenePersonalisation

Parameters

Name	In	Required	Type	Description
uuid	path	required	string	—

Request Body

required

application/json

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

multipart/form-data

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

application/x-www-form-urlencoded

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

Responses

200 —

POST /api/users/{uuid}/scene_personalisation

POST /api/users/{uuid}/validate_2fa

operationId: Users_validate2faCreate

Parameters

Name	In	Required	Type	Description
uuid	path	required	string	—

Request Body

required

application/json

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

multipart/form-data

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

application/x-www-form-urlencoded

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

Responses

200 —

POST /api/users/{uuid}/validate_2fa

POST /api/users/{uuid}/verify_email

operationId: Users_verifyEmailCreate

Parameters

Name	In	Required	Type	Description
uuid	path	required	string	—

Request Body

required

application/json

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

multipart/form-data

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

application/x-www-form-urlencoded

schema User

Property	Type	Required
team	object	required
└ 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	required
email	string	required
is_staff	boolean	optional
password	string	required
last_name	string	optional
first_name	string	optional
theme_mode	object	optional
date_joined	string	required
distinct_id	string	optional
email_opt_in	boolean	optional
has_password	boolean	required
organization	object	required
└ 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	required
└ 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	required
has_social_auth	boolean	required
is_impersonated	boolean	required
…8 more	object	optional

Responses

200 —

POST /api/users/{uuid}/verify_email

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